eventespresso / event-espresso-core

core/db_models/EEM_Line_Item.model.php

Indentation +56 added lines, -56 removed lines

@@ -362,62 +362,62 @@
 
 
 
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param bool|null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = array(
-            'TXN_ID'        => 0,
-            'LIN_type'      => 'total',
-        );
-        if ($expired !== null) {
-            $where_params['LIN_timestamp'] = array(
-                $expired ? '<=' : '>',
-                time() - EE_Registry::instance()->SSN->lifespan(),
-            );
-        }
-        return $this->get_all(array($where_params));
-    }
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param bool|null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = array(
+			'TXN_ID'        => 0,
+			'LIN_type'      => 'total',
+		);
+		if ($expired !== null) {
+			$where_params['LIN_timestamp'] = array(
+				$expired ? '<=' : '>',
+				time() - EE_Registry::instance()->SSN->lifespan(),
+			);
+		}
+		return $this->get_all(array($where_params));
+	}
 
 
 

caffeinated/payment_methods/Mijireh/EEG_Mijireh.gateway.php

Indentation +84 added lines, -84 removed lines

@@ -103,7 +103,7 @@ 
 		}
 		$order = apply_filters( 'FHEE__EEG_Mijireh__set_redirection_info__order_arguments', $order, $payment, $primary_registrant );
 		do_action( 'AHEE_log', __FILE__, __FUNCTION__, serialize(get_object_vars($this)) );
-        $order = $this->_get_unsupported_character_remover()->formatArray($order);
+		$order = $this->_get_unsupported_character_remover()->formatArray($order);
 
 		$args = array(
 			'headers' => array(
@@ -113,45 +113,45 @@ 
 			'body'=>  wp_json_encode($order)
 		);
 		$response = wp_remote_post( $this->_mijireh_api_orders_url, $args );
-                $problems_string = false;
+				$problems_string = false;
 		$this->log(array('get checkout url request_args' => $args, 'response' => $response ), $payment);
 		if( ! $response instanceof WP_Error ){
 			$response_body = json_decode($response['body']);
 			if($response_body && isset($response_body->checkout_url)){
-                            $payment->set_redirect_url($response_body->checkout_url);
-                            $payment->set_txn_id_chq_nmbr($response_body->order_number);
-                            $payment->set_details($response['body']);
+							$payment->set_redirect_url($response_body->checkout_url);
+							$payment->set_txn_id_chq_nmbr($response_body->order_number);
+							$payment->set_details($response['body']);
 			} else {
-                           if( is_array( $response_body ) || is_object( $response_body)){
-                                    $response_body_as_array = (array)$response_body;
-                                    foreach($response_body_as_array as $problem_parameter => $problems){
-                                            $problems_string.= sprintf(__('\nProblems with %s: %s','event_espresso'),$problem_parameter,implode(", ",$problems));
-                                    }
-                            }else{
-                                    $problems_string = $response['body'];
-                            }
-                            if( ! $problems_string ) {
-                                //no message to show? wack
-                                if( isset( $response[ 'headers' ][ 'status' ] ) ){
-                                        $problems_string = $response[ 'headers' ][ 'status' ];
-                                }else{
-                                        $problems_string = __( 'No response from Mijireh', 'event_espresso' );
-                                }
-                            }
-                        }
+						   if( is_array( $response_body ) || is_object( $response_body)){
+									$response_body_as_array = (array)$response_body;
+									foreach($response_body_as_array as $problem_parameter => $problems){
+											$problems_string.= sprintf(__('\nProblems with %s: %s','event_espresso'),$problem_parameter,implode(", ",$problems));
+									}
+							}else{
+									$problems_string = $response['body'];
+							}
+							if( ! $problems_string ) {
+								//no message to show? wack
+								if( isset( $response[ 'headers' ][ 'status' ] ) ){
+										$problems_string = $response[ 'headers' ][ 'status' ];
+								}else{
+										$problems_string = __( 'No response from Mijireh', 'event_espresso' );
+								}
+							}
+						}
 		}else{
-                    $problems_string = implode( ",", $response->get_error_messages() );
+					$problems_string = implode( ",", $response->get_error_messages() );
 		}
                 
-                if( $problems_string ) {
-                    $payment->set_gateway_response( sprintf( __( 'Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string ) );
-                    $payment->set_details( $response );
-                    $payment->set_redirect_url( null );
-                    //even though the payment's status is failed at this point anyways,
-                    //let's be explicit about it. The fact that the redirect url is null
-                    //should be enough to client code that they can't redirect the user
-                    $payment->set_status( $this->_pay_model->failed_status() );
-                }
+				if( $problems_string ) {
+					$payment->set_gateway_response( sprintf( __( 'Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string ) );
+					$payment->set_details( $response );
+					$payment->set_redirect_url( null );
+					//even though the payment's status is failed at this point anyways,
+					//let's be explicit about it. The fact that the redirect url is null
+					//should be enough to client code that they can't redirect the user
+					$payment->set_status( $this->_pay_model->failed_status() );
+				}
 		return $payment;
 	}
 
@@ -188,70 +188,70 @@ 
 	 * @param array $update_info unused. We just use the $transaction
 	 * @param EEI_Transaction $transaction
 	 * @return \EEI_Payment
-     * @throws EE_Error
+	 * @throws EE_Error
 	 */
 	public function handle_payment_update($update_info, $transaction) {
-        foreach( $transaction->pending_payments() as $payment){
-		    $payment = $this->check_payment_in_mijireh($payment);
-            if( $payment->status() === $this->_pay_model->approved_status()){
-                return $payment;
-            }
-        }
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : NULL;
+		foreach( $transaction->pending_payments() as $payment){
+			$payment = $this->check_payment_in_mijireh($payment);
+			if( $payment->status() === $this->_pay_model->approved_status()){
+				return $payment;
+			}
+		}
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : NULL;
 
-        if ( ! $payment instanceof EEI_Payment ){
-            throw new EE_Error( sprintf( __( "Could not find Mijireh payment for transaction %s", 'event_espresso' ), $transaction->ID() ) );
-        }
-        return $payment;
+		if ( ! $payment instanceof EEI_Payment ){
+			throw new EE_Error( sprintf( __( "Could not find Mijireh payment for transaction %s", 'event_espresso' ), $transaction->ID() ) );
+		}
+		return $payment;
 	}
 
 
 
-    /**
-     * Checks the payment's status in Mijireh for this specific payment
-     * @param \EEI_Payment $payment
-     * @return \EEI_Payment
-     */
+	/**
+	 * Checks the payment's status in Mijireh for this specific payment
+	 * @param \EEI_Payment $payment
+	 * @return \EEI_Payment
+	 */
 	public function check_payment_in_mijireh( EEI_Payment $payment ){
-        $request_args = array(
-            'headers' => array(
-                'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
-                'Accept'=>'application/json'
-            )
-        );
+		$request_args = array(
+			'headers' => array(
+				'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
+				'Accept'=>'application/json'
+			)
+		);
 
-        $response = wp_remote_get(
-            $this->_mijireh_api_orders_url . '/' . $payment->txn_id_chq_nmbr(),
-            $request_args
-        );
+		$response = wp_remote_get(
+			$this->_mijireh_api_orders_url . '/' . $payment->txn_id_chq_nmbr(),
+			$request_args
+		);
 
-        $this->log(
-            array( 'get payment status request_args' => $request_args, 'response' => $response ),
-            $payment
-        );
-        // validate response
-        $response_body = isset( $response[ 'body' ] ) ? json_decode( $response[ 'body' ] ) : '';
-        if( $response && $response_body ){
-            switch( $response_body->status ){
-                case 'paid':
-                    $payment->set_status($this->_pay_model->approved_status());
-                    break;
-                case 'pending':
-                    $payment->set_status($this->_pay_model->pending_status());
-                    break;
-                default:
-                    $payment->set_status($this->_pay_model->declined_status());
-            }
+		$this->log(
+			array( 'get payment status request_args' => $request_args, 'response' => $response ),
+			$payment
+		);
+		// validate response
+		$response_body = isset( $response[ 'body' ] ) ? json_decode( $response[ 'body' ] ) : '';
+		if( $response && $response_body ){
+			switch( $response_body->status ){
+				case 'paid':
+					$payment->set_status($this->_pay_model->approved_status());
+					break;
+				case 'pending':
+					$payment->set_status($this->_pay_model->pending_status());
+					break;
+				default:
+					$payment->set_status($this->_pay_model->declined_status());
+			}
 
-        } else {
-            $payment->set_gateway_response( __( 'Response from Mijireh could not be understood.', 'event_espresso' ) );
-            $payment->set_details( $response );
-            $payment->set_status( $this->_pay_model->failed_status() );
-        }
-        // the following is ONLY for testing the Mijireh IPN and should NEVER be uncommented for real usage
+		} else {
+			$payment->set_gateway_response( __( 'Response from Mijireh could not be understood.', 'event_espresso' ) );
+			$payment->set_details( $response );
+			$payment->set_status( $this->_pay_model->failed_status() );
+		}
+		// the following is ONLY for testing the Mijireh IPN and should NEVER be uncommented for real usage
 //		$payment->set_status( $this->_pay_model->pending_status() );
-        return $payment;
-    }
+		return $payment;
+	}
 
 }
 

Spacing +62 added lines, -62 removed lines

@@ -8,7 +8,7 @@ 
  * @author				Mike Nelson
  *
  */
-class EEG_Mijireh extends EE_Offsite_Gateway{
+class EEG_Mijireh extends EE_Offsite_Gateway {
 
 	protected $_access_key;
 
@@ -37,14 +37,14 @@ 
 		$primary_attendee = $primary_registrant->attendee();
 		$items = array();
 		//if we're are charging for the full amount, show the normal line items
-		if( $this->_can_easily_itemize_transaction_for( $payment )){
+		if ($this->_can_easily_itemize_transaction_for($payment)) {
 			$total_line_item = $transaction->total_line_item();
 			$tax_total = $total_line_item->get_total_tax();
-			foreach($total_line_item->get_items() as $line_item){
+			foreach ($total_line_item->get_items() as $line_item) {
 				$items[] = array(
 					'name'=>apply_filters(
 						'FHEE__EEG_Mijireh__set_redirection_info__full_amount_line_item_name',
-						$this->_format_line_item_name( $line_item, $payment ),
+						$this->_format_line_item_name($line_item, $payment),
 						$line_item,
 						$payment,
 						$primary_registrant
@@ -54,13 +54,13 @@ 
 					'quantity'=>$line_item->quantity()
 				);
 			}
-		}else{//its a partial payment
+		} else {//its a partial payment
 			$tax_total = 0;
 			//partial payment, so just add 1 item
 			$items[] = array(
 				'name'=> apply_filters(
 					'FHEE__EEG_Mijireh__set_redirection_info__partial_amount_line_item_name',
-					$this->_format_partial_payment_line_item_name( $payment ),
+					$this->_format_partial_payment_line_item_name($payment),
 					$payment,
 					$primary_registrant
 				),
@@ -72,18 +72,18 @@ 
 		$order = array(
 			'total'=>$this->format_currency($payment->amount()),
 			'return_url'=>$return_url,
-			'items'=>$this->_prepare_for_mijireh( $items ),
+			'items'=>$this->_prepare_for_mijireh($items),
 			'email'=>$primary_attendee->email(),
 			'first_name'=>$primary_attendee->fname(),
 			'last_name'=>$primary_attendee->lname(),
 			'tax'=>$this->format_currency($tax_total),
 			'partner_id'=>'ee');
 		//setup address?
-		if(		$primary_attendee->address()  &&
-				$primary_attendee->city()  &&
-				$primary_attendee->state_ID()  &&
-				$primary_attendee->country_ID()  &&
-				$primary_attendee->zip()  ){
+		if ($primary_attendee->address() &&
+				$primary_attendee->city() &&
+				$primary_attendee->state_ID() &&
+				$primary_attendee->country_ID() &&
+				$primary_attendee->zip()) {
 			$shipping_address = array(
 				'first_name'=>$primary_attendee->fname(),
 				'last_name'=>$primary_attendee->lname(),
@@ -93,64 +93,64 @@ 
 				'zip_code' => $primary_attendee->zip(),
 				'country' => $primary_attendee->country_ID()
 			);
-			if( $primary_attendee->address2() ){
-				$shipping_address[ 'apt_suite' ] = $primary_attendee->address2();
+			if ($primary_attendee->address2()) {
+				$shipping_address['apt_suite'] = $primary_attendee->address2();
 			}
-			if( $primary_attendee->phone() ){
-				$shipping_address[ 'phone' ] = $primary_attendee->phone();
+			if ($primary_attendee->phone()) {
+				$shipping_address['phone'] = $primary_attendee->phone();
 			}
-			$order[ 'shipping_address' ] = $shipping_address;
+			$order['shipping_address'] = $shipping_address;
 		}
-		$order = apply_filters( 'FHEE__EEG_Mijireh__set_redirection_info__order_arguments', $order, $payment, $primary_registrant );
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, serialize(get_object_vars($this)) );
+		$order = apply_filters('FHEE__EEG_Mijireh__set_redirection_info__order_arguments', $order, $payment, $primary_registrant);
+		do_action('AHEE_log', __FILE__, __FUNCTION__, serialize(get_object_vars($this)));
         $order = $this->_get_unsupported_character_remover()->formatArray($order);
 
 		$args = array(
 			'headers' => array(
-				'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
+				'Authorization' => 'Basic '.base64_encode($this->_access_key.':'),
 				'Accept'=>'application/json'
 			),
 			'body'=>  wp_json_encode($order)
 		);
-		$response = wp_remote_post( $this->_mijireh_api_orders_url, $args );
+		$response = wp_remote_post($this->_mijireh_api_orders_url, $args);
                 $problems_string = false;
-		$this->log(array('get checkout url request_args' => $args, 'response' => $response ), $payment);
-		if( ! $response instanceof WP_Error ){
+		$this->log(array('get checkout url request_args' => $args, 'response' => $response), $payment);
+		if ( ! $response instanceof WP_Error) {
 			$response_body = json_decode($response['body']);
-			if($response_body && isset($response_body->checkout_url)){
+			if ($response_body && isset($response_body->checkout_url)) {
                             $payment->set_redirect_url($response_body->checkout_url);
                             $payment->set_txn_id_chq_nmbr($response_body->order_number);
                             $payment->set_details($response['body']);
 			} else {
-                           if( is_array( $response_body ) || is_object( $response_body)){
-                                    $response_body_as_array = (array)$response_body;
-                                    foreach($response_body_as_array as $problem_parameter => $problems){
-                                            $problems_string.= sprintf(__('\nProblems with %s: %s','event_espresso'),$problem_parameter,implode(", ",$problems));
+                           if (is_array($response_body) || is_object($response_body)) {
+                                    $response_body_as_array = (array) $response_body;
+                                    foreach ($response_body_as_array as $problem_parameter => $problems) {
+                                            $problems_string .= sprintf(__('\nProblems with %s: %s', 'event_espresso'), $problem_parameter, implode(", ", $problems));
                                     }
-                            }else{
+                            } else {
                                     $problems_string = $response['body'];
                             }
-                            if( ! $problems_string ) {
+                            if ( ! $problems_string) {
                                 //no message to show? wack
-                                if( isset( $response[ 'headers' ][ 'status' ] ) ){
-                                        $problems_string = $response[ 'headers' ][ 'status' ];
-                                }else{
-                                        $problems_string = __( 'No response from Mijireh', 'event_espresso' );
+                                if (isset($response['headers']['status'])) {
+                                        $problems_string = $response['headers']['status'];
+                                } else {
+                                        $problems_string = __('No response from Mijireh', 'event_espresso');
                                 }
                             }
                         }
-		}else{
-                    $problems_string = implode( ",", $response->get_error_messages() );
+		} else {
+                    $problems_string = implode(",", $response->get_error_messages());
 		}
                 
-                if( $problems_string ) {
-                    $payment->set_gateway_response( sprintf( __( 'Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string ) );
-                    $payment->set_details( $response );
-                    $payment->set_redirect_url( null );
+                if ($problems_string) {
+                    $payment->set_gateway_response(sprintf(__('Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string));
+                    $payment->set_details($response);
+                    $payment->set_redirect_url(null);
                     //even though the payment's status is failed at this point anyways,
                     //let's be explicit about it. The fact that the redirect url is null
                     //should be enough to client code that they can't redirect the user
-                    $payment->set_status( $this->_pay_model->failed_status() );
+                    $payment->set_status($this->_pay_model->failed_status());
                 }
 		return $payment;
 	}
@@ -163,16 +163,16 @@ 
 	 * @param mixed $data
 	 * @return mixed same type as $data
 	 */
-	private function _prepare_for_mijireh( $data ){
-		if( is_array( $data ) ){
+	private function _prepare_for_mijireh($data) {
+		if (is_array($data)) {
 			$prepared_data = array();
-			foreach($data as $key => $datum ){
-				$prepared_data[ $key ] = $this->_prepare_for_mijireh( $datum );
+			foreach ($data as $key => $datum) {
+				$prepared_data[$key] = $this->_prepare_for_mijireh($datum);
 			}
 			return $prepared_data;
-		}elseif(is_string( $data ) ){
-			return str_replace( '%', 'percent', $data );
-		}else{
+		}elseif (is_string($data)) {
+			return str_replace('%', 'percent', $data);
+		} else {
 			return $data;
 		}
 	}
@@ -191,16 +191,16 @@ 
      * @throws EE_Error
 	 */
 	public function handle_payment_update($update_info, $transaction) {
-        foreach( $transaction->pending_payments() as $payment){
+        foreach ($transaction->pending_payments() as $payment) {
 		    $payment = $this->check_payment_in_mijireh($payment);
-            if( $payment->status() === $this->_pay_model->approved_status()){
+            if ($payment->status() === $this->_pay_model->approved_status()) {
                 return $payment;
             }
         }
         $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : NULL;
 
-        if ( ! $payment instanceof EEI_Payment ){
-            throw new EE_Error( sprintf( __( "Could not find Mijireh payment for transaction %s", 'event_espresso' ), $transaction->ID() ) );
+        if ( ! $payment instanceof EEI_Payment) {
+            throw new EE_Error(sprintf(__("Could not find Mijireh payment for transaction %s", 'event_espresso'), $transaction->ID()));
         }
         return $payment;
 	}
@@ -212,27 +212,27 @@ 
      * @param \EEI_Payment $payment
      * @return \EEI_Payment
      */
-	public function check_payment_in_mijireh( EEI_Payment $payment ){
+	public function check_payment_in_mijireh(EEI_Payment $payment) {
         $request_args = array(
             'headers' => array(
-                'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
+                'Authorization' => 'Basic '.base64_encode($this->_access_key.':'),
                 'Accept'=>'application/json'
             )
         );
 
         $response = wp_remote_get(
-            $this->_mijireh_api_orders_url . '/' . $payment->txn_id_chq_nmbr(),
+            $this->_mijireh_api_orders_url.'/'.$payment->txn_id_chq_nmbr(),
             $request_args
         );
 
         $this->log(
-            array( 'get payment status request_args' => $request_args, 'response' => $response ),
+            array('get payment status request_args' => $request_args, 'response' => $response),
             $payment
         );
         // validate response
-        $response_body = isset( $response[ 'body' ] ) ? json_decode( $response[ 'body' ] ) : '';
-        if( $response && $response_body ){
-            switch( $response_body->status ){
+        $response_body = isset($response['body']) ? json_decode($response['body']) : '';
+        if ($response && $response_body) {
+            switch ($response_body->status) {
                 case 'paid':
                     $payment->set_status($this->_pay_model->approved_status());
                     break;
@@ -244,9 +244,9 @@ 
             }
 
         } else {
-            $payment->set_gateway_response( __( 'Response from Mijireh could not be understood.', 'event_espresso' ) );
-            $payment->set_details( $response );
-            $payment->set_status( $this->_pay_model->failed_status() );
+            $payment->set_gateway_response(__('Response from Mijireh could not be understood.', 'event_espresso'));
+            $payment->set_details($response);
+            $payment->set_status($this->_pay_model->failed_status());
         }
         // the following is ONLY for testing the Mijireh IPN and should NEVER be uncommented for real usage
 //		$payment->set_status( $this->_pay_model->pending_status() );

core/services/formatters/FormatterBase.php

Indentation +22 added lines, -22 removed lines

@@ -18,27 +18,27 @@
 abstract class FormatterBase implements FormatterInterface
 {
 
-    /**
-     * Recursively applies the formatting to all VALUES in this multi-dimensional array
-     *
-     * @param array $input
-     * @return array
-     * @throws InvalidDataTypeException if $input is not an array
-     */
-    public function formatArray($input)
-    {
-        if (! is_array($input)) {
-            throw new InvalidDataTypeException('input', $input, 'array');
-        }
-        //we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
-        $formatter = $this;
-        array_walk_recursive(
-            $input,
-            function (&$value, $key) use ($formatter) {
-                $value = $formatter->format($value);
-            }
-        );
-        return $input;
-    }}
+	/**
+	 * Recursively applies the formatting to all VALUES in this multi-dimensional array
+	 *
+	 * @param array $input
+	 * @return array
+	 * @throws InvalidDataTypeException if $input is not an array
+	 */
+	public function formatArray($input)
+	{
+		if (! is_array($input)) {
+			throw new InvalidDataTypeException('input', $input, 'array');
+		}
+		//we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
+		$formatter = $this;
+		array_walk_recursive(
+			$input,
+			function (&$value, $key) use ($formatter) {
+				$value = $formatter->format($value);
+			}
+		);
+		return $input;
+	}}
 // End of file FormatterBase.php
 // Location: core\services\formatters/FormatterBase.php
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -27,14 +27,14 @@
      */
     public function formatArray($input)
     {
-        if (! is_array($input)) {
+        if ( ! is_array($input)) {
             throw new InvalidDataTypeException('input', $input, 'array');
         }
         //we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
         $formatter = $this;
         array_walk_recursive(
             $input,
-            function (&$value, $key) use ($formatter) {
+            function(&$value, $key) use ($formatter) {
                 $value = $formatter->format($value);
             }
         );

modules/core_rest_api/EED_Core_Rest_Api.module.php

Indentation +791 added lines, -791 removed lines

@@ -18,807 +18,807 @@
 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 ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
 
-    const saved_routes_option_names  = 'ee_core_routes';
+	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/';
+	/**
+	 * 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;
+	/**
+	 * @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__);
-    }
+	/**
+	 * @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();
-    }
-
-
-
-    /**
-     * 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();
-    }
-
-
-
-
-
-
-
-    /**
-     * 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)
-    {
-    }
+	/**
+	 *    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();
+	}
+
+
+
+	/**
+	 * 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();
+	}
+
+
+
+
+
+
+
+	/**
+	 * 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)
+	{
+	}
 }
 
 // End of file EED_Core_Rest_Api.module.php

core/libraries/form_sections/inputs/EE_Datepicker_Input.php

Spacing +11 added lines, -11 removed lines

@@ -6,21 +6,21 @@ 
  * @subpackage
  * @author				Mike Nelson
  */
-class EE_Datepicker_Input extends EE_Form_Input_Base{
+class EE_Datepicker_Input extends EE_Form_Input_Base {
 
 	/**
 	 * @param array $input_settings
 	 */
-	function __construct( $input_settings = array() ){
-		$this->_set_display_strategy( new EE_Text_Input_Display_Strategy( 'datepicker' ) );
-		$this->_set_normalization_strategy( new EE_Text_Normalization() );
+	function __construct($input_settings = array()) {
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy('datepicker'));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
 		//we could do better for validation, but at least verify its plaintext
-		$this->_add_validation_strategy( new EE_Plaintext_Validation_Strategy( isset( $input_settings[ 'validation_error_message' ] ) ? $input_settings[ 'validation_error_message' ] : NULL ) );
-		parent::__construct( $input_settings );
-		$this->set_html_class( $this->html_class() . ' datepicker' );
+		$this->_add_validation_strategy(new EE_Plaintext_Validation_Strategy(isset($input_settings['validation_error_message']) ? $input_settings['validation_error_message'] : NULL));
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class().' datepicker');
 		// add some style and make it dance
-		add_action( 'wp_enqueue_scripts', array( 'EE_Datepicker_Input', 'enqueue_styles_and_scripts' ));
-		add_action( 'admin_enqueue_scripts', array( 'EE_Datepicker_Input', 'enqueue_styles_and_scripts' ));
+		add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
+		add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
 	}
 
 
@@ -33,8 +33,8 @@ 
 	 */
 	public static function enqueue_styles_and_scripts() {
 		// load css
-		wp_register_style( 'espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION );
-		wp_enqueue_style( 'espresso-ui-theme');
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso-ui-theme');
 	}
 
 

core/helpers/EEH_Schema.helper.php

Indentation +66 added lines, -66 removed lines

@@ -17,67 +17,67 @@ 
 class EEH_Schema {
 
 
-    /**
-     * generates JSON-based linked data for an event
-     *
-     * @param \EE_Event $event
-     */
-    public static function add_json_linked_data_for_event(\EE_Event $event)
-    {
-    	//Check we have a valid datetime for the event
-    	if(! $event->primary_datetime() instanceof EE_Datetime) {
-    		return;
-    	}
-
-        $template_args = array(
-            'event_permalink' => '',
-            'event_name' => '',
-            'event_description' => '',
-            'event_start' => '',
-            'event_end' => '',
-            'currency' => '',
-            'event_tickets' => array(),
-            'venue_name' => '',
-            'venue_url' => '',
-            'venue_locality' => '',
-            'venue_region' => '',
-            'event_image' => '',
-        );
-        $template_args['event_permalink'] = $event->get_permalink();
-        $template_args['event_name'] = $event->name();
-        $template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
-        $template_args['event_start'] = $event->primary_datetime()->start_date(DateTime::ATOM);
-        $template_args['event_end'] = $event->primary_datetime()->end_date(DateTime::ATOM);
-        $template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
-        foreach ($event->tickets() as $ticket) {
-            $ID = $ticket->ID();
-            $template_args['event_tickets'][$ID]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][$ID]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
-            $template_args['event_tickets'][$ID]['price'] = number_format(
-                $ticket->price(),
-                EE_Registry::instance()->CFG->currency->dec_plc,
-                EE_Registry::instance()->CFG->currency->dec_mrk,
-                EE_Registry::instance()->CFG->currency->thsnds
-            );
-        }
-        $VNU_ID = espresso_venue_id();
-        if ( ! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
-            $venue = EEH_Venue_View::get_venue($VNU_ID);
-            $template_args['venue_name'] = get_the_title($VNU_ID);
-            $template_args['venue_url'] = get_permalink($VNU_ID);
-            $template_args['venue_locality'] = $venue->city();
-            $template_args['venue_region'] = $venue->state_name();
-        }
-        $template_args['event_image'] = $event->feature_image_url();
-        $template_args = apply_filters(
-            'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
-            $template_args,
-            $event,
-            $VNU_ID
-        );
-        extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
-    }
+	/**
+	 * generates JSON-based linked data for an event
+	 *
+	 * @param \EE_Event $event
+	 */
+	public static function add_json_linked_data_for_event(\EE_Event $event)
+	{
+		//Check we have a valid datetime for the event
+		if(! $event->primary_datetime() instanceof EE_Datetime) {
+			return;
+		}
+
+		$template_args = array(
+			'event_permalink' => '',
+			'event_name' => '',
+			'event_description' => '',
+			'event_start' => '',
+			'event_end' => '',
+			'currency' => '',
+			'event_tickets' => array(),
+			'venue_name' => '',
+			'venue_url' => '',
+			'venue_locality' => '',
+			'venue_region' => '',
+			'event_image' => '',
+		);
+		$template_args['event_permalink'] = $event->get_permalink();
+		$template_args['event_name'] = $event->name();
+		$template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
+		$template_args['event_start'] = $event->primary_datetime()->start_date(DateTime::ATOM);
+		$template_args['event_end'] = $event->primary_datetime()->end_date(DateTime::ATOM);
+		$template_args['currency'] = EE_Registry::instance()->CFG->currency->code;
+		foreach ($event->tickets() as $ticket) {
+			$ID = $ticket->ID();
+			$template_args['event_tickets'][$ID]['start_date'] = $ticket->start_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][$ID]['end_date'] = $ticket->end_date(DateTime::ATOM, null);
+			$template_args['event_tickets'][$ID]['price'] = number_format(
+				$ticket->price(),
+				EE_Registry::instance()->CFG->currency->dec_plc,
+				EE_Registry::instance()->CFG->currency->dec_mrk,
+				EE_Registry::instance()->CFG->currency->thsnds
+			);
+		}
+		$VNU_ID = espresso_venue_id();
+		if ( ! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
+			$venue = EEH_Venue_View::get_venue($VNU_ID);
+			$template_args['venue_name'] = get_the_title($VNU_ID);
+			$template_args['venue_url'] = get_permalink($VNU_ID);
+			$template_args['venue_locality'] = $venue->city();
+			$template_args['venue_region'] = $venue->state_name();
+		}
+		$template_args['event_image'] = $event->feature_image_url();
+		$template_args = apply_filters(
+			'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
+			$template_args,
+			$event,
+			$VNU_ID
+		);
+		extract($template_args, EXTR_OVERWRITE);
+		include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+	}
 
 
 	/**
@@ -91,8 +91,8 @@ 
 	 */
 	public static function location( $location = null ) {
 		return ! empty( $location ) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
-		                              . $location
-		                              . '</div>' : '';
+									  . $location
+									  . '</div>' : '';
 	}
 
 
@@ -212,8 +212,8 @@ 
 	 */
 	public static function postalCode( EEI_Address $obj_with_address = null ) {
 		return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
-		                                                                              . $obj_with_address->zip()
-		                                                                              . '</span>' : '';
+																					  . $obj_with_address->zip()
+																					  . '</span>' : '';
 	}
 
 
@@ -247,7 +247,7 @@ 
 		//Check the URL includes a scheme
 		$parsed_url = parse_url($url);
 		if ( empty($parsed_url['scheme']) ) {
-		    $url = 'http://' . ltrim($url, '/');
+			$url = 'http://' . ltrim($url, '/');
 		}
 
 		$atts = '';

Spacing +31 added lines, -31 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -25,7 +25,7 @@ 
     public static function add_json_linked_data_for_event(\EE_Event $event)
     {
     	//Check we have a valid datetime for the event
-    	if(! $event->primary_datetime() instanceof EE_Datetime) {
+    	if ( ! $event->primary_datetime() instanceof EE_Datetime) {
     		return;
     	}
 
@@ -76,7 +76,7 @@ 
             $VNU_ID
         );
         extract($template_args, EXTR_OVERWRITE);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+        include EE_TEMPLATES.'json_linked_data_for_event.template.php';
     }
 
 
@@ -89,8 +89,8 @@ 
 	 * @param string $location
 	 * @return string
 	 */
-	public static function location( $location = null ) {
-		return ! empty( $location ) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
+	public static function location($location = null) {
+		return ! empty($location) ? '<div itemprop="location" itemscope itemtype="http://schema.org/Place">'
 		                              . $location
 		                              . '</div>' : '';
 	}
@@ -105,8 +105,8 @@ 
 	 * @param string $name
 	 * @return string
 	 */
-	public static function name( $name = null ) {
-		return ! empty( $name ) ? '<span itemprop="name">' . $name . '</span>' : '';
+	public static function name($name = null) {
+		return ! empty($name) ? '<span itemprop="name">'.$name.'</span>' : '';
 	}
 
 
@@ -119,9 +119,9 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function streetAddress( EEI_Address $obj_with_address = null ) {
+	public static function streetAddress(EEI_Address $obj_with_address = null) {
 		return $obj_with_address->address() !== null && $obj_with_address->address() !== ''
-			? '<span itemprop="streetAddress">' . $obj_with_address->address() . '</span>' : '';
+			? '<span itemprop="streetAddress">'.$obj_with_address->address().'</span>' : '';
 	}
 
 
@@ -134,14 +134,14 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function postOfficeBoxNumber( EEI_Address $obj_with_address = null ) {
+	public static function postOfficeBoxNumber(EEI_Address $obj_with_address = null) {
 		// regex check for some form of PO Box or P.O. Box, etc, etc, etc
-		if ( preg_match(
+		if (preg_match(
 			"/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
 			$obj_with_address->address2()
-		) ) {
+		)) {
 			return $obj_with_address->address2() !== null && $obj_with_address->address2() !== ''
-				? '<span itemprop="postOfficeBoxNumber">' . $obj_with_address->address2() . '</span>' : '';
+				? '<span itemprop="postOfficeBoxNumber">'.$obj_with_address->address2().'</span>' : '';
 		} else {
 			return $obj_with_address->address2();
 		}
@@ -157,9 +157,9 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function addressLocality( EEI_Address $obj_with_address = null ) {
+	public static function addressLocality(EEI_Address $obj_with_address = null) {
 		return $obj_with_address->city() !== null && $obj_with_address->city() !== ''
-			? '<span itemprop="addressLocality">' . $obj_with_address->city() . '</span>' : '';
+			? '<span itemprop="addressLocality">'.$obj_with_address->city().'</span>' : '';
 	}
 
 
@@ -172,10 +172,10 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function addressRegion( EEI_Address $obj_with_address = null ) {
+	public static function addressRegion(EEI_Address $obj_with_address = null) {
 		$state = $obj_with_address->state_name();
-		if ( ! empty( $state ) ) {
-			return '<span itemprop="addressRegion">' . $state . '</span>';
+		if ( ! empty($state)) {
+			return '<span itemprop="addressRegion">'.$state.'</span>';
 		} else {
 			return '';
 		}
@@ -191,10 +191,10 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function addressCountry( EEI_Address $obj_with_address = null ) {
+	public static function addressCountry(EEI_Address $obj_with_address = null) {
 		$country = $obj_with_address->country_name();
-		if ( ! empty( $country ) ) {
-			return '<span itemprop="addressCountry">' . $country . '</span>';
+		if ( ! empty($country)) {
+			return '<span itemprop="addressCountry">'.$country.'</span>';
 		} else {
 			return '';
 		}
@@ -210,7 +210,7 @@ 
 	 * @param EEI_Address $obj_with_address
 	 * @return string
 	 */
-	public static function postalCode( EEI_Address $obj_with_address = null ) {
+	public static function postalCode(EEI_Address $obj_with_address = null) {
 		return $obj_with_address->zip() !== null && $obj_with_address->zip() !== '' ? '<span itemprop="postalCode">'
 		                                                                              . $obj_with_address->zip()
 		                                                                              . '</span>' : '';
@@ -226,8 +226,8 @@ 
 	 * @param string $phone_nmbr
 	 * @return string
 	 */
-	public static function telephone( $phone_nmbr = null ) {
-		return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">' . $phone_nmbr . '</span>'
+	public static function telephone($phone_nmbr = null) {
+		return $phone_nmbr !== null && $phone_nmbr !== '' ? '<span itemprop="telephone">'.$phone_nmbr.'</span>'
 			: '';
 	}
 
@@ -243,19 +243,19 @@ 
 	 * @param array  $attributes - array of additional link attributes in  attribute_name => value pairs. ie: array( 'title' => 'click here', 'class' => 'link-class' )
 	 * @return string (link)
 	 */
-	public static function url( $url = null, $text = null, $attributes = array() ) {
+	public static function url($url = null, $text = null, $attributes = array()) {
 		//Check the URL includes a scheme
 		$parsed_url = parse_url($url);
-		if ( empty($parsed_url['scheme']) ) {
-		    $url = 'http://' . ltrim($url, '/');
+		if (empty($parsed_url['scheme'])) {
+		    $url = 'http://'.ltrim($url, '/');
 		}
 
 		$atts = '';
-		foreach ( $attributes as $attribute => $value ) {
-			$atts .= ' ' . $attribute . '="' . $value . '"';
+		foreach ($attributes as $attribute => $value) {
+			$atts .= ' '.$attribute.'="'.$value.'"';
 		}
 		$text = $text !== null && $text !== '' ? $text : $url;
-		return $url !== null && $url !== '' ? '<a itemprop="url" href="' . $url . '"' . $atts . '>' . $text . '</a>'
+		return $url !== null && $url !== '' ? '<a itemprop="url" href="'.$url.'"'.$atts.'>'.$text.'</a>'
 			: '';
 	}
 

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

Indentation +1380 added lines, -1380 removed lines

@@ -11,1386 +11,1386 @@
 class EE_Form_Section_Proper extends EE_Form_Section_Validatable
 {
 
-    const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
-
-    /**
-     * Subsections
-     *
-     * @var EE_Form_Section_Validatable[]
-     */
-    protected $_subsections = array();
-
-    /**
-     * Strategy for laying out the form
-     *
-     * @var EE_Form_Section_Layout_Base
-     */
-    protected $_layout_strategy;
-
-    /**
-     * Whether or not this form has received and validated a form submission yet
-     *
-     * @var boolean
-     */
-    protected $_received_submission = false;
-
-    /**
-     * message displayed to users upon successful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_success_message = '';
-
-    /**
-     * message displayed to users upon unsuccessful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_error_message = '';
-
-    /**
-     * Stores all the data that will localized for form validation
-     *
-     * @var array
-     */
-    static protected $_js_localization = array();
-
-    /**
-     * whether or not the form's localized validation JS vars have been set
-     *
-     * @type boolean
-     */
-    static protected $_scripts_localized = false;
-
-
-
-    /**
-     * when constructing a proper form section, calls _construct_finalize on children
-     * so that they know who their parent is, and what name they've been given.
-     *
-     * @param array $options_array   {
-     * @type        $subsections     EE_Form_Section_Validatable[] where keys are the section's name
-     * @type        $include         string[] numerically-indexed where values are section names to be included,
-     *                               and in that order. This is handy if you want
-     *                               the subsections to be ordered differently than the default, and if you override
-     *                               which fields are shown
-     * @type        $exclude         string[] values are subsections to be excluded. This is handy if you want
-     *                               to remove certain default subsections (note: if you specify BOTH 'include' AND
-     *                               'exclude', the inclusions will be applied first, and the exclusions will exclude
-     *                               items from that list of inclusions)
-     * @type        $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
-     *                               } @see EE_Form_Section_Validatable::__construct()
-     * @throws \EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        $options_array = (array)apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array,
-            $this);
-        //call parent first, as it may be setting the name
-        parent::__construct($options_array);
-        //if they've included subsections in the constructor, add them now
-        if (isset($options_array['include'])) {
-            //we are going to make sure we ONLY have those subsections to include
-            //AND we are going to make sure they're in that specified order
-            $reordered_subsections = array();
-            foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[$input_name])) {
-                    $reordered_subsections[$input_name] = $this->_subsections[$input_name];
-                }
-            }
-            $this->_subsections = $reordered_subsections;
-        }
-        if (isset($options_array['exclude'])) {
-            $exclude = $options_array['exclude'];
-            $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
-        }
-        if (isset($options_array['layout_strategy'])) {
-            $this->_layout_strategy = $options_array['layout_strategy'];
-        }
-        if (! $this->_layout_strategy) {
-            $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
-        }
-        $this->_layout_strategy->_construct_finalize($this);
-        //ok so we are definitely going to want the forms JS,
-        //so enqueue it or remember to enqueue it during wp_enqueue_scripts
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            //ok so they've constructed this object after when they should have.
-            //just enqueue the generic form scripts and initialize the form immediately in the JS
-            \EE_Form_Section_Proper::wp_enqueue_scripts(true);
-        } else {
-            add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-            add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-        }
-        add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
-
-        /**
-         * Gives other plugins a chance to hook in before construct finalize is called. The form probably doesn't
-         * yet have a parent form section. Since 4.9.32, when this action was introduced, this is the best place to
-         * add a subsection onto a form, assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
-         * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
-         * @since 4.9.32
-         * @param EE_Form_Section_Proper $this before __construct is done, but all of its logic, except maybe calling
-         *                                      _construct_finalize has been done
-         * @param array $options_array options passed into the constructor
-         */
-        do_action('AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called', $this, $options_array);
-
-        if (isset($options_array['name'])) {
-            $this->_construct_finalize(null, $options_array['name']);
-        }
-    }
-
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws \EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        $this->_set_default_name_if_empty();
-        $this->_set_default_html_id_if_empty();
-        foreach ($this->_subsections as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Base) {
-                $subsection->_construct_finalize($this, $subsection_name);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        __('Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
-                            'event_espresso'),
-                        $subsection_name,
-                        get_class($this),
-                        $subsection ? get_class($subsection) : __('NULL', 'event_espresso')
-                    )
-                );
-            }
-        }
-        /**
-         * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
-         * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID (or other attributes derived
-         * from the name like the HTML label id, etc), this is where it should be done.
-         * This might only happen just before displaying the form, or just before it receives form submission data.
-         * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
-         * ensured it has a name, HTML IDs, etc
-         * @param EE_Form_Section_Proper $this
-         * @param EE_Form_Section_Proper|null $parent_form_section
-         * @param string $name
-         */
-        do_action('AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name);
-    }
-
-
-
-    /**
-     * Gets the layout strategy for this form section
-     *
-     * @return EE_Form_Section_Layout_Base
-     */
-    public function get_layout_strategy()
-    {
-        return $this->_layout_strategy;
-    }
-
-
-
-    /**
-     * Gets the HTML for a single input for this form section according
-     * to the layout strategy
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function get_html_for_input($input)
-    {
-        return $this->_layout_strategy->layout_input($input);
-    }
-
-
-
-    /**
-     * was_submitted - checks if form inputs are present in request data
-     * Basically an alias for form_data_present_in() (which is used by both
-     * proper form sections and form inputs)
-     *
-     * @param null $form_data
-     * @return boolean
-     */
-    public function was_submitted($form_data = null)
-    {
-        return $this->form_data_present_in($form_data);
-    }
-
-
-
-    /**
-     * After the form section is initially created, call this to sanitize the data in the submission
-     * which relates to this form section, validate it, and set it as properties on the form.
-     *
-     * @param array|null $req_data should usually be $_POST (the default).
-     *                             However, you CAN supply a different array.
-     *                             Consider using set_defaults() instead however.
-     *                             (If you rendered the form in the page using echo $form_x->get_html()
-     *                             the inputs will have the correct name in the request data for this function
-     *                             to find them and populate the form with them.
-     *                             If you have a flat form (with only input subsections),
-     *                             you can supply a flat array where keys
-     *                             are the form input names and values are their values)
-     * @param boolean    $validate whether or not to perform validation on this data. Default is,
-     *                             of course, to validate that data, and set errors on the invalid values.
-     *                             But if the data has already been validated
-     *                             (eg you validated the data then stored it in the DB)
-     *                             you may want to skip this step.
-     */
-    public function receive_form_submission($req_data = null, $validate = true)
-    {
-        $req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this,
-            $validate);
-        if ($req_data === null) {
-            $req_data = array_merge($_GET, $_POST);
-        }
-        $req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data,
-            $this);
-        $this->_normalize($req_data);
-        if ($validate) {
-            $this->_validate();
-            //if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
-                $this->store_submitted_form_data_in_session();
-            }
-        }
-        do_action('AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate);
-    }
-
-
-
-    /**
-     * caches the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return boolean whether or not the data was successfully stored in the session
-     */
-    protected function store_submitted_form_data_in_session()
-    {
-        return EE_Registry::instance()->SSN->set_session_data(
-            array(
-                \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
-            )
-        );
-    }
-
-
-
-    /**
-     * retrieves the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return array
-     */
-    protected function get_submitted_form_data_from_session()
-    {
-        $session = EE_Registry::instance()->SSN;
-        if ($session instanceof EE_Session) {
-            return $session->get_session_data(
-                \EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
-            );
-        } else {
-            return array();
-        }
-    }
-
-
-
-    /**
-     * flushed the originally submitted input values from the session
-     *
-     * @return boolean whether or not the data was successfully removed from the session
-     */
-    protected function flush_submitted_form_data_from_session()
-    {
-        return EE_Registry::instance()->SSN->reset_data(
-            array(\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
-        );
-    }
-
-
-
-    /**
-     * Populates this form and its subsections with data from the session.
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
-     * validation errors when displaying too)
-     * Returns true if the form was populated from the session, false otherwise
-     *
-     * @return boolean
-     */
-    public function populate_from_session()
-    {
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
-        if (empty($form_data_in_session)) {
-            return false;
-        }
-        $this->receive_form_submission($form_data_in_session);
-        $this->flush_submitted_form_data_from_session();
-        if ($this->form_data_present_in($form_data_in_session)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Populates the default data for the form, given an array where keys are
-     * the input names, and values are their values (preferably normalized to be their
-     * proper PHP types, not all strings... although that should be ok too).
-     * Proper subsections are sub-arrays, the key being the subsection's name, and
-     * the value being an array formatted in teh same way
-     *
-     * @param array $default_data
-     */
-    public function populate_defaults($default_data)
-    {
-        foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[$subsection_name])) {
-                if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[$subsection_name]);
-                } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[$subsection_name]);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * returns true if subsection exists
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function subsection_exists($name)
-    {
-        return isset($this->_subsections[$name]) ? true : false;
-    }
-
-
-
-    /**
-     * Gets the subsection specified by its name
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
-     *                                                      so that the inputs will be properly configured.
-     *                                                      However, some client code may be ok
-     *                                                      with construction finalize being called later
-     *                                                      (realizing that the subsections' html names
-     *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
-     * @throws \EE_Error
-     */
-    public function get_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
-    }
-
-
-
-    /**
-     * Gets all the validatable subsections of this form section
-     *
-     * @return EE_Form_Section_Validatable[]
-     */
-    public function get_validatable_subsections()
-    {
-        $validatable_subsections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[$name] = $obj;
-            }
-        }
-        return $validatable_subsections;
-    }
-
-
-
-    /**
-     * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
-     * throw an EE_Error.
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function get_input($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
-        if (! $subsection instanceof EE_Form_Input_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this),
-                    $subsection ? get_class($subsection) : __("NULL", 'event_espresso')
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-
-    /**
-     * Like get_input(), gets the proper subsection of the form given the name,
-     * otherwise throws an EE_Error
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
-        if (! $subsection instanceof EE_Form_Section_Proper) {
-            throw new EE_Error(
-                sprintf(
-                    __("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'),
-                    $name,
-                    get_class($this)
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-
-    /**
-     * Gets the value of the specified input. Should be called after receive_form_submission()
-     * or populate_defaults() on the form, where the normalized value on the input is set.
-     *
-     * @param string $name
-     * @return mixed depending on the input's type and its normalization strategy
-     * @throws \EE_Error
-     */
-    public function get_input_value($name)
-    {
-        $input = $this->get_input($name);
-        return $input->normalized_value();
-    }
-
-
-
-    /**
-     * Checks if this form section itself is valid, and then checks its subsections
-     *
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if (! $this->has_received_submission()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "You cannot check if a form is valid before receiving the form submission using receive_form_submission",
-                        "event_espresso"
-                    )
-                )
-            );
-        }
-        if (! parent::is_valid()) {
-            return false;
-        }
-        // ok so no general errors to this entire form section.
-        // so let's check the subsections, but only set errors if that hasn't been done yet
-        $set_submission_errors = $this->submission_error_message() === '' ? true : false;
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
-                if ($set_submission_errors) {
-                    $this->set_submission_error_message($subsection->get_validation_error_string());
-                }
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * gets teh default name of this form section if none is specified
-     *
-     * @return string
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $classname = get_class($this);
-            $default_name = str_replace("EE_", "", $classname);
-            $this->_name = $default_name;
-        }
-    }
-
-
-
-    /**
-     * Returns the HTML for the form, except for the form opening and closing tags
-     * (as the form section doesn't know where you necessarily want to send the information to),
-     * and except for a submit button. Enqueus JS and CSS; if called early enough we will
-     * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
-     * Not doing_it_wrong because theoretically this CAN be used properly,
-     * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
-     * any CSS.
-     *
-     * @throws \EE_Error
-     */
-    public function get_html_and_js()
-    {
-        $this->enqueue_js();
-        return $this->get_html();
-    }
-
-
-
-    /**
-     * returns HTML for displaying this form section. recursively calls display_section() on all subsections
-     *
-     * @param bool $display_previously_submitted_data
-     * @return string
-     */
-    public function get_html($display_previously_submitted_data = true)
-    {
-        $this->ensure_construct_finalized_called();
-        if ($display_previously_submitted_data) {
-            $this->populate_from_session();
-        }
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
-            : $this->_layout_strategy->layout_form();
-    }
-
-
-
-    /**
-     * enqueues JS and CSS for the form.
-     * It is preferred to call this before wp_enqueue_scripts so the
-     * scripts and styles can be put in the header, but if called later
-     * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
-     * only be in the header; but in HTML5 its ok in the body.
-     * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
-     * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function enqueue_js()
-    {
-        $this->_enqueue_and_localize_form_js();
-        foreach ($this->subsections() as $subsection) {
-            $subsection->enqueue_js();
-        }
-    }
-
-
-
-    /**
-     * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
-     * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
-     * the wp_enqueue_scripts hook.
-     * However, registering the form js and localizing it can happen when we
-     * actually output the form (which is preferred, seeing how teh form's fields
-     * could change until it's actually outputted)
-     *
-     * @param boolean $init_form_validation_automatically whether or not we want the form validation
-     *                                                    to be triggered automatically or not
-     * @return void
-     */
-    public static function wp_enqueue_scripts($init_form_validation_automatically = true)
-    {
-        add_filter('FHEE_load_jquery_validate', '__return_true');
-        wp_register_script(
-            'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
-            array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_validation_init',
-            array('init' => $init_form_validation_automatically ? true : false)
-        );
-    }
-
-
-
-    /**
-     * gets the variables used by form_section_validation.js.
-     * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
-     * but before the wordpress hook wp_loaded
-     *
-     * @throws \EE_Error
-     */
-    public function _enqueue_and_localize_form_js()
-    {
-        $this->ensure_construct_finalized_called();
-        //actually, we don't want to localize just yet. There may be other forms on the page.
-        //so we need to add our form section data to a static variable accessible by all form sections
-        //and localize it just before the footer
-        $this->localize_validation_rules();
-        add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
-        add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
-    }
-
-
-
-    /**
-     * add our form section data to a static variable accessible by all form sections
-     *
-     * @param bool $return_for_subsection
-     * @return void
-     * @throws \EE_Error
-     */
-    public function localize_validation_rules($return_for_subsection = false)
-    {
-        // we only want to localize vars ONCE for the entire form,
-        // so if the form section doesn't have a parent, then it must be the top dog
-        if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
-                'form_section_id'  => $this->html_id(true),
-                'validation_rules' => $this->get_jquery_validation_rules(),
-                'other_data'       => $this->get_other_js_data(),
-                'errors'           => $this->subsection_validation_errors_by_html_name(),
-            );
-            EE_Form_Section_Proper::$_scripts_localized = true;
-        }
-    }
-
-
-
-    /**
-     * Gets an array of extra data that will be useful for client-side javascript.
-     * This is primarily data added by inputs and forms in addition to any
-     * scripts they might enqueue
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        foreach ($this->subsections() as $subsection) {
-            $form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-
-    /**
-     * Gets a flat array of inputs for this form section and its subsections.
-     * Keys are their form names, and values are the inputs themselves
-     *
-     * @return EE_Form_Input_Base
-     */
-    public function inputs_in_subsections()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[$subsection->html_name()] = $subsection;
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs += $subsection->inputs_in_subsections();
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Gets a flat array of all the validation errors.
-     * Keys are html names (because those should be unique)
-     * and values are a string of all their validation errors
-     *
-     * @return string[]
-     */
-    public function subsection_validation_errors_by_html_name()
-    {
-        $inputs = $this->inputs();
-        $errors = array();
-        foreach ($inputs as $form_input) {
-            if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[$form_input->html_name()] = $form_input->get_validation_error_string();
-            }
-        }
-        return $errors;
-    }
-
-
-
-    /**
-     * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
-     * Should be setup by each form during the _enqueues_and_localize_form_js
-     */
-    public static function localize_script_for_all_forms()
-    {
-        //allow inputs and stuff to hook in their JS and stuff here
-        do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
-        EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
-        $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
-        wp_enqueue_script('ee_form_section_validation');
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_vars',
-            EE_Form_Section_Proper::$_js_localization
-        );
-    }
-
-
-
-    /**
-     * ensure_scripts_localized
-     */
-    public function ensure_scripts_localized()
-    {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
-            $this->_enqueue_and_localize_form_js();
-        }
-    }
-
-
-
-    /**
-     * Gets the hard-coded validation error messages to be used in the JS. The convention
-     * is that the key here should be the same as the custom validation rule put in the JS file
-     *
-     * @return array keys are custom validation rules, and values are internationalized strings
-     */
-    private static function _get_localized_error_messages()
-    {
-        return array(
-            'validUrl' => __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"),
-            'regex'    => __('Please check your input', 'event_espresso'),
-        );
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public static function js_localization()
-    {
-        return self::$_js_localization;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public static function reset_js_localization()
-    {
-        self::$_js_localization = array();
-    }
-
-
-
-    /**
-     * Gets the JS to put inside the jquery validation rules for subsection of this form section.
-     * See parent function for more...
-     *
-     * @return array
-     */
-    public function get_jquery_validation_rules()
-    {
-        $jquery_validation_rules = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $jquery_validation_rules = array_merge(
-                $jquery_validation_rules,
-                $subsection->get_jquery_validation_rules()
-            );
-        }
-        return $jquery_validation_rules;
-    }
-
-
-
-    /**
-     * Sanitizes all the data and sets the sanitized value of each field
-     *
-     * @param array $req_data like $_POST
-     * @return void
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            try {
-                $subsection->_normalize($req_data);
-            } catch (EE_Validation_Error $e) {
-                $subsection->add_validation_error($e);
-            }
-        }
-    }
-
-
-
-    /**
-     * Performs validation on this form section and its subsections.
-     * For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists)
-     * and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple)
-     * you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     */
-    protected function _validate()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
-            }
-            $subsection->_validate();
-        }
-    }
-
-
-
-    /**
-     * Gets all the validated inputs for the form section
-     *
-     * @return array
-     */
-    public function valid_data()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[$subsection_name] = $subsection->valid_data();
-            } else if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[$subsection_name] = $subsection->normalized_value();
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Gets all the inputs on this form section
-     *
-     * @return EE_Form_Input_Base[]
-     */
-    public function inputs()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[$subsection_name] = $subsection;
-            }
-        }
-        return $inputs;
-    }
-
-
-
-    /**
-     * Gets all the subsections which are a proper form
-     *
-     * @return EE_Form_Section_Proper[]
-     */
-    public function subforms()
-    {
-        $form_sections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[$name] = $obj;
-            }
-        }
-        return $form_sections;
-    }
-
-
-
-    /**
-     * Gets all the subsections (inputs, proper subsections, or html-only sections).
-     * Consider using inputs() or subforms()
-     * if you only want form inputs or proper form sections.
-     *
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper[]
-     */
-    public function subsections($require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->_subsections;
-    }
-
-
-
-    /**
-     * Returns a simple array where keys are input names, and values are their normalized
-     * values. (Similar to calling get_input_value on inputs)
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     */
-    public function input_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(false, $include_subform_inputs, $flatten);
-    }
-
-
-
-    /**
-     * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
-     * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
-     * is not necessarily the value we want to display to users. This creates an array
-     * where keys are the input names, and values are their display values
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     */
-    public function input_pretty_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(true, $include_subform_inputs, $flatten);
-    }
-
-
-
-    /**
-     * Gets the input values from the form
-     *
-     * @param boolean $pretty                 Whether to retrieve the pretty value,
-     *                                        or just the normalized value
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
-     *                                        input names (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     */
-    public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
-    {
-        $input_values = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[$subsection_name] = $pretty
-                    ? $subsection->pretty_value()
-                    : $subsection->normalized_value();
-            } else if ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
-                $subform_input_values = $subsection->_input_values($pretty, $include_subform_inputs, $flatten);
-                if ($flatten) {
-                    $input_values = array_merge($input_values, $subform_input_values);
-                } else {
-                    $input_values[$subsection_name] = $subform_input_values;
-                }
-            }
-        }
-        return $input_values;
-    }
-
-
-
-    /**
-     * Gets the originally submitted input values from the form
-     *
-     * @param boolean $include_subforms  Whether to include inputs from subforms,
-     *                                   or just this forms' direct children inputs
-     * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
-     *                                   with array keys being input names
-     *                                   (regardless of whether they are from a subsection or not),
-     *                                   and if $flatten is FALSE it can be a multidimensional array
-     *                                   where keys are always subsection names and values are either
-     *                                   the input's normalized value, or an array like the top-level array
-     */
-    public function submitted_values($include_subforms = false)
-    {
-        $submitted_values = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                // is this input part of an array of inputs?
-                if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name = \EEH_Array::convert_array_values_to_keys(
-                        explode('[', str_replace(']', '', $subsection->html_name())),
-                        $subsection->raw_value()
-                    );
-                    $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
-                } else {
-                    $submitted_values[$subsection->html_name()] = $subsection->raw_value();
-                }
-            } else if ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
-                $subform_input_values = $subsection->submitted_values($include_subforms);
-                $submitted_values = array_replace_recursive($submitted_values, $subform_input_values);
-            }
-        }
-        return $submitted_values;
-    }
-
-
-
-    /**
-     * Indicates whether or not this form has received a submission yet
-     * (ie, had receive_form_submission called on it yet)
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function has_received_submission()
-    {
-        $this->ensure_construct_finalized_called();
-        return $this->_received_submission;
-    }
-
-
-
-    /**
-     * Equivalent to passing 'exclude' in the constructor's options array.
-     * Removes the listed inputs from the form
-     *
-     * @param array $inputs_to_exclude values are the input names
-     * @return void
-     */
-    public function exclude(array $inputs_to_exclude = array())
-    {
-        foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[$input_to_exclude_name]);
-        }
-    }
-
-
-
-    /**
-     * @param array $inputs_to_hide
-     * @throws \EE_Error
-     */
-    public function hide(array $inputs_to_hide = array())
-    {
-        foreach ($inputs_to_hide as $input_to_hide) {
-            $input = $this->get_input($input_to_hide);
-            $input->set_display_strategy(new EE_Hidden_Display_Strategy());
-        }
-    }
-
-
-
-    /**
-     * add_subsections
-     * Adds the listed subsections to the form section.
-     * If $subsection_name_to_target is provided,
-     * then new subsections are added before or after that subsection,
-     * otherwise to the start or end of the entire subsections array.
-     *
-     * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
-     *                                                          where keys are their names
-     * @param string                 $subsection_name_to_target an existing for section that $new_subsections
-     *                                                          should be added before or after
-     *                                                          IF $subsection_name_to_target is null,
-     *                                                          then $new_subsections will be added to
-     *                                                          the beginning or end of the entire subsections array
-     * @param boolean                $add_before                whether to add $new_subsections, before or after
-     *                                                          $subsection_name_to_target,
-     *                                                          or if $subsection_name_to_target is null,
-     *                                                          before or after entire subsections array
-     * @return void
-     * @throws \EE_Error
-     */
-    public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
-    {
-        foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
-                            "event_espresso"
-                        ),
-                        get_class($subsection),
-                        $subsection_name,
-                        $this->name()
-                    )
-                );
-                unset($new_subsections[$subsection_name]);
-            }
-        }
-        $this->_subsections = EEH_Array::insert_into_array(
-            $this->_subsections,
-            $new_subsections,
-            $subsection_name_to_target,
-            $add_before
-        );
-        if ($this->_construction_finalized) {
-            foreach ($this->_subsections as $name => $subsection) {
-                $subsection->_construct_finalize($this, $name);
-            }
-        }
-    }
-
-
-
-    /**
-     * Just gets all validatable subsections to clean their sensitive data
-     */
-    public function clean_sensitive_data()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $subsection->clean_sensitive_data();
-        }
-    }
-
-
-
-    /**
-     * @param string $form_submission_error_message
-     */
-    public function set_submission_error_message($form_submission_error_message = '')
-    {
-        $this->_form_submission_error_message .= ! empty($form_submission_error_message)
-            ? $form_submission_error_message
-            : __('Form submission failed due to errors', 'event_espresso');
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function submission_error_message()
-    {
-        return $this->_form_submission_error_message;
-    }
-
-
-
-    /**
-     * @param string $form_submission_success_message
-     */
-    public function set_submission_success_message($form_submission_success_message)
-    {
-        $this->_form_submission_success_message .= ! empty($form_submission_success_message)
-            ? $form_submission_success_message
-            : __('Form submitted successfully', 'event_espresso');
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function submission_success_message()
-    {
-        return $this->_form_submission_success_message;
-    }
-
-
-
-    /**
-     * Returns the prefix that should be used on child of this form section for
-     * their html names. If this form section itself has a parent, prepends ITS
-     * prefix onto this form section's prefix. Used primarily by
-     * EE_Form_Input_Base::_set_default_html_name_if_empty
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function html_name_prefix()
-    {
-        if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
-        } else {
-            return $this->name();
-        }
-    }
-
-
-
-    /**
-     * Gets the name, but first checks _construct_finalize has been called. If not,
-     * calls it (assumes there is no parent and that we want the name to be whatever
-     * was set, which is probably nothing, or the classname)
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function name()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::name();
-    }
-
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function parent_section()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::parent_section();
-    }
-
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-
-    /**
-     * Checks if any of this form section's inputs, or any of its children's inputs,
-     * are in teh form data. If any are found, returns true. Else false
-     *
-     * @param array $req_data
-     * @return boolean
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            $req_data = $_POST;
-        }
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Gets validation errors for this form section and subsections
-     * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
-     * gets the validation errors for ALL subsection
-     *
-     * @return EE_Validation_Error[]
-     */
-    public function get_validation_errors_accumulated()
-    {
-        $validation_errors = $this->get_validation_errors();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
-            } else {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors();
-            }
-            if ($validation_errors_on_this_subsection) {
-                $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
-            }
-        }
-        return $validation_errors;
-    }
-
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        //check if we can find the input from purely going straight up the tree
-        $input = parent::find_section_from_path($form_section_path);
-        if ($input instanceof EE_Form_Section_Base) {
-            return $input;
-        }
-        $next_slash_pos = strpos($form_section_path, '/');
-        if ($next_slash_pos !== false) {
-            $child_section_name = substr($form_section_path, 0, $next_slash_pos);
-            $subpath = substr($form_section_path, $next_slash_pos + 1);
-        } else {
-            $child_section_name = $form_section_path;
-            $subpath = '';
-        }
-        $child_section = $this->get_subsection($child_section_name);
-        if ($child_section instanceof EE_Form_Section_Base) {
-            return $child_section->find_section_from_path($subpath);
-        } else {
-            return null;
-        }
-    }
+	const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
+
+	/**
+	 * Subsections
+	 *
+	 * @var EE_Form_Section_Validatable[]
+	 */
+	protected $_subsections = array();
+
+	/**
+	 * Strategy for laying out the form
+	 *
+	 * @var EE_Form_Section_Layout_Base
+	 */
+	protected $_layout_strategy;
+
+	/**
+	 * Whether or not this form has received and validated a form submission yet
+	 *
+	 * @var boolean
+	 */
+	protected $_received_submission = false;
+
+	/**
+	 * message displayed to users upon successful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_success_message = '';
+
+	/**
+	 * message displayed to users upon unsuccessful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_error_message = '';
+
+	/**
+	 * Stores all the data that will localized for form validation
+	 *
+	 * @var array
+	 */
+	static protected $_js_localization = array();
+
+	/**
+	 * whether or not the form's localized validation JS vars have been set
+	 *
+	 * @type boolean
+	 */
+	static protected $_scripts_localized = false;
+
+
+
+	/**
+	 * when constructing a proper form section, calls _construct_finalize on children
+	 * so that they know who their parent is, and what name they've been given.
+	 *
+	 * @param array $options_array   {
+	 * @type        $subsections     EE_Form_Section_Validatable[] where keys are the section's name
+	 * @type        $include         string[] numerically-indexed where values are section names to be included,
+	 *                               and in that order. This is handy if you want
+	 *                               the subsections to be ordered differently than the default, and if you override
+	 *                               which fields are shown
+	 * @type        $exclude         string[] values are subsections to be excluded. This is handy if you want
+	 *                               to remove certain default subsections (note: if you specify BOTH 'include' AND
+	 *                               'exclude', the inclusions will be applied first, and the exclusions will exclude
+	 *                               items from that list of inclusions)
+	 * @type        $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
+	 *                               } @see EE_Form_Section_Validatable::__construct()
+	 * @throws \EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		$options_array = (array)apply_filters('FHEE__EE_Form_Section_Proper___construct__options_array', $options_array,
+			$this);
+		//call parent first, as it may be setting the name
+		parent::__construct($options_array);
+		//if they've included subsections in the constructor, add them now
+		if (isset($options_array['include'])) {
+			//we are going to make sure we ONLY have those subsections to include
+			//AND we are going to make sure they're in that specified order
+			$reordered_subsections = array();
+			foreach ($options_array['include'] as $input_name) {
+				if (isset($this->_subsections[$input_name])) {
+					$reordered_subsections[$input_name] = $this->_subsections[$input_name];
+				}
+			}
+			$this->_subsections = $reordered_subsections;
+		}
+		if (isset($options_array['exclude'])) {
+			$exclude = $options_array['exclude'];
+			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
+		}
+		if (isset($options_array['layout_strategy'])) {
+			$this->_layout_strategy = $options_array['layout_strategy'];
+		}
+		if (! $this->_layout_strategy) {
+			$this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
+		}
+		$this->_layout_strategy->_construct_finalize($this);
+		//ok so we are definitely going to want the forms JS,
+		//so enqueue it or remember to enqueue it during wp_enqueue_scripts
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			//ok so they've constructed this object after when they should have.
+			//just enqueue the generic form scripts and initialize the form immediately in the JS
+			\EE_Form_Section_Proper::wp_enqueue_scripts(true);
+		} else {
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+		}
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
+
+		/**
+		 * Gives other plugins a chance to hook in before construct finalize is called. The form probably doesn't
+		 * yet have a parent form section. Since 4.9.32, when this action was introduced, this is the best place to
+		 * add a subsection onto a form, assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
+		 * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
+		 * @since 4.9.32
+		 * @param EE_Form_Section_Proper $this before __construct is done, but all of its logic, except maybe calling
+		 *                                      _construct_finalize has been done
+		 * @param array $options_array options passed into the constructor
+		 */
+		do_action('AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called', $this, $options_array);
+
+		if (isset($options_array['name'])) {
+			$this->_construct_finalize(null, $options_array['name']);
+		}
+	}
+
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws \EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		$this->_set_default_name_if_empty();
+		$this->_set_default_html_id_if_empty();
+		foreach ($this->_subsections as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Base) {
+				$subsection->_construct_finalize($this, $subsection_name);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						__('Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
+							'event_espresso'),
+						$subsection_name,
+						get_class($this),
+						$subsection ? get_class($subsection) : __('NULL', 'event_espresso')
+					)
+				);
+			}
+		}
+		/**
+		 * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
+		 * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID (or other attributes derived
+		 * from the name like the HTML label id, etc), this is where it should be done.
+		 * This might only happen just before displaying the form, or just before it receives form submission data.
+		 * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
+		 * ensured it has a name, HTML IDs, etc
+		 * @param EE_Form_Section_Proper $this
+		 * @param EE_Form_Section_Proper|null $parent_form_section
+		 * @param string $name
+		 */
+		do_action('AHEE__EE_Form_Section_Proper___construct_finalize__end', $this, $parent_form_section, $name);
+	}
+
+
+
+	/**
+	 * Gets the layout strategy for this form section
+	 *
+	 * @return EE_Form_Section_Layout_Base
+	 */
+	public function get_layout_strategy()
+	{
+		return $this->_layout_strategy;
+	}
+
+
+
+	/**
+	 * Gets the HTML for a single input for this form section according
+	 * to the layout strategy
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function get_html_for_input($input)
+	{
+		return $this->_layout_strategy->layout_input($input);
+	}
+
+
+
+	/**
+	 * was_submitted - checks if form inputs are present in request data
+	 * Basically an alias for form_data_present_in() (which is used by both
+	 * proper form sections and form inputs)
+	 *
+	 * @param null $form_data
+	 * @return boolean
+	 */
+	public function was_submitted($form_data = null)
+	{
+		return $this->form_data_present_in($form_data);
+	}
+
+
+
+	/**
+	 * After the form section is initially created, call this to sanitize the data in the submission
+	 * which relates to this form section, validate it, and set it as properties on the form.
+	 *
+	 * @param array|null $req_data should usually be $_POST (the default).
+	 *                             However, you CAN supply a different array.
+	 *                             Consider using set_defaults() instead however.
+	 *                             (If you rendered the form in the page using echo $form_x->get_html()
+	 *                             the inputs will have the correct name in the request data for this function
+	 *                             to find them and populate the form with them.
+	 *                             If you have a flat form (with only input subsections),
+	 *                             you can supply a flat array where keys
+	 *                             are the form input names and values are their values)
+	 * @param boolean    $validate whether or not to perform validation on this data. Default is,
+	 *                             of course, to validate that data, and set errors on the invalid values.
+	 *                             But if the data has already been validated
+	 *                             (eg you validated the data then stored it in the DB)
+	 *                             you may want to skip this step.
+	 */
+	public function receive_form_submission($req_data = null, $validate = true)
+	{
+		$req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__req_data', $req_data, $this,
+			$validate);
+		if ($req_data === null) {
+			$req_data = array_merge($_GET, $_POST);
+		}
+		$req_data = apply_filters('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data', $req_data,
+			$this);
+		$this->_normalize($req_data);
+		if ($validate) {
+			$this->_validate();
+			//if it's invalid, we're going to want to re-display so remember what they submitted
+			if (! $this->is_valid()) {
+				$this->store_submitted_form_data_in_session();
+			}
+		}
+		do_action('AHEE__EE_Form_Section_Proper__receive_form_submission__end', $req_data, $this, $validate);
+	}
+
+
+
+	/**
+	 * caches the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return boolean whether or not the data was successfully stored in the session
+	 */
+	protected function store_submitted_form_data_in_session()
+	{
+		return EE_Registry::instance()->SSN->set_session_data(
+			array(
+				\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
+			)
+		);
+	}
+
+
+
+	/**
+	 * retrieves the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return array
+	 */
+	protected function get_submitted_form_data_from_session()
+	{
+		$session = EE_Registry::instance()->SSN;
+		if ($session instanceof EE_Session) {
+			return $session->get_session_data(
+				\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
+			);
+		} else {
+			return array();
+		}
+	}
+
+
+
+	/**
+	 * flushed the originally submitted input values from the session
+	 *
+	 * @return boolean whether or not the data was successfully removed from the session
+	 */
+	protected function flush_submitted_form_data_from_session()
+	{
+		return EE_Registry::instance()->SSN->reset_data(
+			array(\EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
+		);
+	}
+
+
+
+	/**
+	 * Populates this form and its subsections with data from the session.
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
+	 * validation errors when displaying too)
+	 * Returns true if the form was populated from the session, false otherwise
+	 *
+	 * @return boolean
+	 */
+	public function populate_from_session()
+	{
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
+		if (empty($form_data_in_session)) {
+			return false;
+		}
+		$this->receive_form_submission($form_data_in_session);
+		$this->flush_submitted_form_data_from_session();
+		if ($this->form_data_present_in($form_data_in_session)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Populates the default data for the form, given an array where keys are
+	 * the input names, and values are their values (preferably normalized to be their
+	 * proper PHP types, not all strings... although that should be ok too).
+	 * Proper subsections are sub-arrays, the key being the subsection's name, and
+	 * the value being an array formatted in teh same way
+	 *
+	 * @param array $default_data
+	 */
+	public function populate_defaults($default_data)
+	{
+		foreach ($this->subsections(false) as $subsection_name => $subsection) {
+			if (isset($default_data[$subsection_name])) {
+				if ($subsection instanceof EE_Form_Input_Base) {
+					$subsection->set_default($default_data[$subsection_name]);
+				} elseif ($subsection instanceof EE_Form_Section_Proper) {
+					$subsection->populate_defaults($default_data[$subsection_name]);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * returns true if subsection exists
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function subsection_exists($name)
+	{
+		return isset($this->_subsections[$name]) ? true : false;
+	}
+
+
+
+	/**
+	 * Gets the subsection specified by its name
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
+	 *                                                      so that the inputs will be properly configured.
+	 *                                                      However, some client code may be ok
+	 *                                                      with construction finalize being called later
+	 *                                                      (realizing that the subsections' html names
+	 *                                                      might not be set yet, etc.)
+	 * @return EE_Form_Section_Base
+	 * @throws \EE_Error
+	 */
+	public function get_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
+	}
+
+
+
+	/**
+	 * Gets all the validatable subsections of this form section
+	 *
+	 * @return EE_Form_Section_Validatable[]
+	 */
+	public function get_validatable_subsections()
+	{
+		$validatable_subsections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Validatable) {
+				$validatable_subsections[$name] = $obj;
+			}
+		}
+		return $validatable_subsections;
+	}
+
+
+
+	/**
+	 * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
+	 * throw an EE_Error.
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function get_input($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
+		if (! $subsection instanceof EE_Form_Input_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this),
+					$subsection ? get_class($subsection) : __("NULL", 'event_espresso')
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+
+	/**
+	 * Like get_input(), gets the proper subsection of the form given the name,
+	 * otherwise throws an EE_Error
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection($name, $require_construction_to_be_finalized);
+		if (! $subsection instanceof EE_Form_Section_Proper) {
+			throw new EE_Error(
+				sprintf(
+					__("Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'", 'event_espresso'),
+					$name,
+					get_class($this)
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+
+	/**
+	 * Gets the value of the specified input. Should be called after receive_form_submission()
+	 * or populate_defaults() on the form, where the normalized value on the input is set.
+	 *
+	 * @param string $name
+	 * @return mixed depending on the input's type and its normalization strategy
+	 * @throws \EE_Error
+	 */
+	public function get_input_value($name)
+	{
+		$input = $this->get_input($name);
+		return $input->normalized_value();
+	}
+
+
+
+	/**
+	 * Checks if this form section itself is valid, and then checks its subsections
+	 *
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if (! $this->has_received_submission()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"You cannot check if a form is valid before receiving the form submission using receive_form_submission",
+						"event_espresso"
+					)
+				)
+			);
+		}
+		if (! parent::is_valid()) {
+			return false;
+		}
+		// ok so no general errors to this entire form section.
+		// so let's check the subsections, but only set errors if that hasn't been done yet
+		$set_submission_errors = $this->submission_error_message() === '' ? true : false;
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if (! $subsection->is_valid() || $subsection->get_validation_error_string() !== '') {
+				if ($set_submission_errors) {
+					$this->set_submission_error_message($subsection->get_validation_error_string());
+				}
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * gets teh default name of this form section if none is specified
+	 *
+	 * @return string
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$classname = get_class($this);
+			$default_name = str_replace("EE_", "", $classname);
+			$this->_name = $default_name;
+		}
+	}
+
+
+
+	/**
+	 * Returns the HTML for the form, except for the form opening and closing tags
+	 * (as the form section doesn't know where you necessarily want to send the information to),
+	 * and except for a submit button. Enqueus JS and CSS; if called early enough we will
+	 * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
+	 * Not doing_it_wrong because theoretically this CAN be used properly,
+	 * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
+	 * any CSS.
+	 *
+	 * @throws \EE_Error
+	 */
+	public function get_html_and_js()
+	{
+		$this->enqueue_js();
+		return $this->get_html();
+	}
+
+
+
+	/**
+	 * returns HTML for displaying this form section. recursively calls display_section() on all subsections
+	 *
+	 * @param bool $display_previously_submitted_data
+	 * @return string
+	 */
+	public function get_html($display_previously_submitted_data = true)
+	{
+		$this->ensure_construct_finalized_called();
+		if ($display_previously_submitted_data) {
+			$this->populate_from_session();
+		}
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
+			: $this->_layout_strategy->layout_form();
+	}
+
+
+
+	/**
+	 * enqueues JS and CSS for the form.
+	 * It is preferred to call this before wp_enqueue_scripts so the
+	 * scripts and styles can be put in the header, but if called later
+	 * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
+	 * only be in the header; but in HTML5 its ok in the body.
+	 * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
+	 * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function enqueue_js()
+	{
+		$this->_enqueue_and_localize_form_js();
+		foreach ($this->subsections() as $subsection) {
+			$subsection->enqueue_js();
+		}
+	}
+
+
+
+	/**
+	 * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
+	 * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
+	 * the wp_enqueue_scripts hook.
+	 * However, registering the form js and localizing it can happen when we
+	 * actually output the form (which is preferred, seeing how teh form's fields
+	 * could change until it's actually outputted)
+	 *
+	 * @param boolean $init_form_validation_automatically whether or not we want the form validation
+	 *                                                    to be triggered automatically or not
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true)
+	{
+		add_filter('FHEE_load_jquery_validate', '__return_true');
+		wp_register_script(
+			'ee_form_section_validation',
+			EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
+			array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_validation_init',
+			array('init' => $init_form_validation_automatically ? true : false)
+		);
+	}
+
+
+
+	/**
+	 * gets the variables used by form_section_validation.js.
+	 * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
+	 * but before the wordpress hook wp_loaded
+	 *
+	 * @throws \EE_Error
+	 */
+	public function _enqueue_and_localize_form_js()
+	{
+		$this->ensure_construct_finalized_called();
+		//actually, we don't want to localize just yet. There may be other forms on the page.
+		//so we need to add our form section data to a static variable accessible by all form sections
+		//and localize it just before the footer
+		$this->localize_validation_rules();
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
+	}
+
+
+
+	/**
+	 * add our form section data to a static variable accessible by all form sections
+	 *
+	 * @param bool $return_for_subsection
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function localize_validation_rules($return_for_subsection = false)
+	{
+		// we only want to localize vars ONCE for the entire form,
+		// so if the form section doesn't have a parent, then it must be the top dog
+		if ($return_for_subsection || ! $this->parent_section()) {
+			EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
+				'form_section_id'  => $this->html_id(true),
+				'validation_rules' => $this->get_jquery_validation_rules(),
+				'other_data'       => $this->get_other_js_data(),
+				'errors'           => $this->subsection_validation_errors_by_html_name(),
+			);
+			EE_Form_Section_Proper::$_scripts_localized = true;
+		}
+	}
+
+
+
+	/**
+	 * Gets an array of extra data that will be useful for client-side javascript.
+	 * This is primarily data added by inputs and forms in addition to any
+	 * scripts they might enqueue
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		foreach ($this->subsections() as $subsection) {
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+
+	/**
+	 * Gets a flat array of inputs for this form section and its subsections.
+	 * Keys are their form names, and values are the inputs themselves
+	 *
+	 * @return EE_Form_Input_Base
+	 */
+	public function inputs_in_subsections()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[$subsection->html_name()] = $subsection;
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs += $subsection->inputs_in_subsections();
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Gets a flat array of all the validation errors.
+	 * Keys are html names (because those should be unique)
+	 * and values are a string of all their validation errors
+	 *
+	 * @return string[]
+	 */
+	public function subsection_validation_errors_by_html_name()
+	{
+		$inputs = $this->inputs();
+		$errors = array();
+		foreach ($inputs as $form_input) {
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
+				$errors[$form_input->html_name()] = $form_input->get_validation_error_string();
+			}
+		}
+		return $errors;
+	}
+
+
+
+	/**
+	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
+	 * Should be setup by each form during the _enqueues_and_localize_form_js
+	 */
+	public static function localize_script_for_all_forms()
+	{
+		//allow inputs and stuff to hook in their JS and stuff here
+		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
+		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
+		wp_enqueue_script('ee_form_section_validation');
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_vars',
+			EE_Form_Section_Proper::$_js_localization
+		);
+	}
+
+
+
+	/**
+	 * ensure_scripts_localized
+	 */
+	public function ensure_scripts_localized()
+	{
+		if (! EE_Form_Section_Proper::$_scripts_localized) {
+			$this->_enqueue_and_localize_form_js();
+		}
+	}
+
+
+
+	/**
+	 * Gets the hard-coded validation error messages to be used in the JS. The convention
+	 * is that the key here should be the same as the custom validation rule put in the JS file
+	 *
+	 * @return array keys are custom validation rules, and values are internationalized strings
+	 */
+	private static function _get_localized_error_messages()
+	{
+		return array(
+			'validUrl' => __("This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg", "event_espresso"),
+			'regex'    => __('Please check your input', 'event_espresso'),
+		);
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public static function js_localization()
+	{
+		return self::$_js_localization;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public static function reset_js_localization()
+	{
+		self::$_js_localization = array();
+	}
+
+
+
+	/**
+	 * Gets the JS to put inside the jquery validation rules for subsection of this form section.
+	 * See parent function for more...
+	 *
+	 * @return array
+	 */
+	public function get_jquery_validation_rules()
+	{
+		$jquery_validation_rules = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$jquery_validation_rules = array_merge(
+				$jquery_validation_rules,
+				$subsection->get_jquery_validation_rules()
+			);
+		}
+		return $jquery_validation_rules;
+	}
+
+
+
+	/**
+	 * Sanitizes all the data and sets the sanitized value of each field
+	 *
+	 * @param array $req_data like $_POST
+	 * @return void
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			try {
+				$subsection->_normalize($req_data);
+			} catch (EE_Validation_Error $e) {
+				$subsection->add_validation_error($e);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Performs validation on this form section and its subsections.
+	 * For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists)
+	 * and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple)
+	 * you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 */
+	protected function _validate()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if (method_exists($this, '_validate_' . $subsection_name)) {
+				call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+			}
+			$subsection->_validate();
+		}
+	}
+
+
+
+	/**
+	 * Gets all the validated inputs for the form section
+	 *
+	 * @return array
+	 */
+	public function valid_data()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs[$subsection_name] = $subsection->valid_data();
+			} else if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[$subsection_name] = $subsection->normalized_value();
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Gets all the inputs on this form section
+	 *
+	 * @return EE_Form_Input_Base[]
+	 */
+	public function inputs()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[$subsection_name] = $subsection;
+			}
+		}
+		return $inputs;
+	}
+
+
+
+	/**
+	 * Gets all the subsections which are a proper form
+	 *
+	 * @return EE_Form_Section_Proper[]
+	 */
+	public function subforms()
+	{
+		$form_sections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Proper) {
+				$form_sections[$name] = $obj;
+			}
+		}
+		return $form_sections;
+	}
+
+
+
+	/**
+	 * Gets all the subsections (inputs, proper subsections, or html-only sections).
+	 * Consider using inputs() or subforms()
+	 * if you only want form inputs or proper form sections.
+	 *
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper[]
+	 */
+	public function subsections($require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->_subsections;
+	}
+
+
+
+	/**
+	 * Returns a simple array where keys are input names, and values are their normalized
+	 * values. (Similar to calling get_input_value on inputs)
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 */
+	public function input_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
+	}
+
+
+
+	/**
+	 * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
+	 * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
+	 * is not necessarily the value we want to display to users. This creates an array
+	 * where keys are the input names, and values are their display values
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 */
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
+	}
+
+
+
+	/**
+	 * Gets the input values from the form
+	 *
+	 * @param boolean $pretty                 Whether to retrieve the pretty value,
+	 *                                        or just the normalized value
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
+	 *                                        input names (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 */
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
+	{
+		$input_values = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$input_values[$subsection_name] = $pretty
+					? $subsection->pretty_value()
+					: $subsection->normalized_value();
+			} else if ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
+				$subform_input_values = $subsection->_input_values($pretty, $include_subform_inputs, $flatten);
+				if ($flatten) {
+					$input_values = array_merge($input_values, $subform_input_values);
+				} else {
+					$input_values[$subsection_name] = $subform_input_values;
+				}
+			}
+		}
+		return $input_values;
+	}
+
+
+
+	/**
+	 * Gets the originally submitted input values from the form
+	 *
+	 * @param boolean $include_subforms  Whether to include inputs from subforms,
+	 *                                   or just this forms' direct children inputs
+	 * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                   with array keys being input names
+	 *                                   (regardless of whether they are from a subsection or not),
+	 *                                   and if $flatten is FALSE it can be a multidimensional array
+	 *                                   where keys are always subsection names and values are either
+	 *                                   the input's normalized value, or an array like the top-level array
+	 */
+	public function submitted_values($include_subforms = false)
+	{
+		$submitted_values = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				// is this input part of an array of inputs?
+				if (strpos($subsection->html_name(), '[') !== false) {
+					$full_input_name = \EEH_Array::convert_array_values_to_keys(
+						explode('[', str_replace(']', '', $subsection->html_name())),
+						$subsection->raw_value()
+					);
+					$submitted_values = array_replace_recursive($submitted_values, $full_input_name);
+				} else {
+					$submitted_values[$subsection->html_name()] = $subsection->raw_value();
+				}
+			} else if ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
+				$subform_input_values = $subsection->submitted_values($include_subforms);
+				$submitted_values = array_replace_recursive($submitted_values, $subform_input_values);
+			}
+		}
+		return $submitted_values;
+	}
+
+
+
+	/**
+	 * Indicates whether or not this form has received a submission yet
+	 * (ie, had receive_form_submission called on it yet)
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function has_received_submission()
+	{
+		$this->ensure_construct_finalized_called();
+		return $this->_received_submission;
+	}
+
+
+
+	/**
+	 * Equivalent to passing 'exclude' in the constructor's options array.
+	 * Removes the listed inputs from the form
+	 *
+	 * @param array $inputs_to_exclude values are the input names
+	 * @return void
+	 */
+	public function exclude(array $inputs_to_exclude = array())
+	{
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
+			unset($this->_subsections[$input_to_exclude_name]);
+		}
+	}
+
+
+
+	/**
+	 * @param array $inputs_to_hide
+	 * @throws \EE_Error
+	 */
+	public function hide(array $inputs_to_hide = array())
+	{
+		foreach ($inputs_to_hide as $input_to_hide) {
+			$input = $this->get_input($input_to_hide);
+			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
+		}
+	}
+
+
+
+	/**
+	 * add_subsections
+	 * Adds the listed subsections to the form section.
+	 * If $subsection_name_to_target is provided,
+	 * then new subsections are added before or after that subsection,
+	 * otherwise to the start or end of the entire subsections array.
+	 *
+	 * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
+	 *                                                          where keys are their names
+	 * @param string                 $subsection_name_to_target an existing for section that $new_subsections
+	 *                                                          should be added before or after
+	 *                                                          IF $subsection_name_to_target is null,
+	 *                                                          then $new_subsections will be added to
+	 *                                                          the beginning or end of the entire subsections array
+	 * @param boolean                $add_before                whether to add $new_subsections, before or after
+	 *                                                          $subsection_name_to_target,
+	 *                                                          or if $subsection_name_to_target is null,
+	 *                                                          before or after entire subsections array
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
+	{
+		foreach ($new_subsections as $subsection_name => $subsection) {
+			if (! $subsection instanceof EE_Form_Section_Base) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							"Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
+							"event_espresso"
+						),
+						get_class($subsection),
+						$subsection_name,
+						$this->name()
+					)
+				);
+				unset($new_subsections[$subsection_name]);
+			}
+		}
+		$this->_subsections = EEH_Array::insert_into_array(
+			$this->_subsections,
+			$new_subsections,
+			$subsection_name_to_target,
+			$add_before
+		);
+		if ($this->_construction_finalized) {
+			foreach ($this->_subsections as $name => $subsection) {
+				$subsection->_construct_finalize($this, $name);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Just gets all validatable subsections to clean their sensitive data
+	 */
+	public function clean_sensitive_data()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$subsection->clean_sensitive_data();
+		}
+	}
+
+
+
+	/**
+	 * @param string $form_submission_error_message
+	 */
+	public function set_submission_error_message($form_submission_error_message = '')
+	{
+		$this->_form_submission_error_message .= ! empty($form_submission_error_message)
+			? $form_submission_error_message
+			: __('Form submission failed due to errors', 'event_espresso');
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function submission_error_message()
+	{
+		return $this->_form_submission_error_message;
+	}
+
+
+
+	/**
+	 * @param string $form_submission_success_message
+	 */
+	public function set_submission_success_message($form_submission_success_message)
+	{
+		$this->_form_submission_success_message .= ! empty($form_submission_success_message)
+			? $form_submission_success_message
+			: __('Form submitted successfully', 'event_espresso');
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function submission_success_message()
+	{
+		return $this->_form_submission_success_message;
+	}
+
+
+
+	/**
+	 * Returns the prefix that should be used on child of this form section for
+	 * their html names. If this form section itself has a parent, prepends ITS
+	 * prefix onto this form section's prefix. Used primarily by
+	 * EE_Form_Input_Base::_set_default_html_name_if_empty
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function html_name_prefix()
+	{
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
+			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+		} else {
+			return $this->name();
+		}
+	}
+
+
+
+	/**
+	 * Gets the name, but first checks _construct_finalize has been called. If not,
+	 * calls it (assumes there is no parent and that we want the name to be whatever
+	 * was set, which is probably nothing, or the classname)
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function name()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::name();
+	}
+
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function parent_section()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::parent_section();
+	}
+
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+
+	/**
+	 * Checks if any of this form section's inputs, or any of its children's inputs,
+	 * are in teh form data. If any are found, returns true. Else false
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			$req_data = $_POST;
+		}
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Gets validation errors for this form section and subsections
+	 * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
+	 * gets the validation errors for ALL subsection
+	 *
+	 * @return EE_Validation_Error[]
+	 */
+	public function get_validation_errors_accumulated()
+	{
+		$validation_errors = $this->get_validation_errors();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
+			} else {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
+			}
+			if ($validation_errors_on_this_subsection) {
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
+			}
+		}
+		return $validation_errors;
+	}
+
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		//check if we can find the input from purely going straight up the tree
+		$input = parent::find_section_from_path($form_section_path);
+		if ($input instanceof EE_Form_Section_Base) {
+			return $input;
+		}
+		$next_slash_pos = strpos($form_section_path, '/');
+		if ($next_slash_pos !== false) {
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
+			$subpath = substr($form_section_path, $next_slash_pos + 1);
+		} else {
+			$child_section_name = $form_section_path;
+			$subpath = '';
+		}
+		$child_section = $this->get_subsection($child_section_name);
+		if ($child_section instanceof EE_Form_Section_Base) {
+			return $child_section->find_section_from_path($subpath);
+		} else {
+			return null;
+		}
+	}
 
 }
 

core/libraries/form_sections/inputs/EE_Form_Input_Base.input.php

Indentation +1127 added lines, -1127 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,1130 +16,1130 @@ 
 abstract class EE_Form_Input_Base extends EE_Form_Section_Validatable
 {
 
-    /**
-     * the input's name attribute
-     *
-     * @var string
-     */
-    protected $_html_name;
-
-    /**
-     * id for the html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_id;
-
-    /**
-     * class for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_class;
-
-    /**
-     * any additional html attributes that you may want to add
-     *
-     * @var string
-     */
-    protected $_html_other_attributes;
-
-    /**
-     * style for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_style;
-
-    /**
-     * text to be placed in the html label
-     *
-     * @var string
-     */
-    protected $_html_label_text;
-
-    /**
-     * the full html label. If used, all other html_label_* properties are invalid
-     *
-     * @var string
-     */
-    protected $_html_label;
-
-    /**
-     * HTML to use for help text (normally placed below form input), in a span which normally
-     * has a class of 'description'
-     *
-     * @var string
-     */
-    protected $_html_help_text;
-
-    /**
-     * CSS classes for displaying the help span
-     *
-     * @var string
-     */
-    protected $_html_help_class = 'description';
-
-    /**
-     * CSS to put in the style attribute on the help span
-     *
-     * @var string
-     */
-    protected $_html_help_style;
-
-    /**
-     * Stores whether or not this input's response is required.
-     * Because certain styling elements may also want to know that this
-     * input is required etc.
-     *
-     * @var boolean
-     */
-    protected $_required;
-
-    /**
-     * css class added to required inputs
-     *
-     * @var string
-     */
-    protected $_required_css_class = 'ee-required';
-
-    /**
-     * css styles applied to button type inputs
-     *
-     * @var string
-     */
-    protected $_button_css_attributes;
-
-    /**
-     * The raw data submitted for this, like in the $_POST super global.
-     * Generally unsafe for usage in client code
-     *
-     * @var mixed string or array
-     */
-    protected $_raw_value;
-
-    /**
-     * Value normalized according to the input's normalization strategy.
-     * The normalization strategy dictates whether this is a string, int, float,
-     * boolean, or array of any of those.
-     *
-     * @var mixed
-     */
-    protected $_normalized_value;
-
-    /**
-     * Strategy used for displaying this field.
-     * Child classes must use _get_display_strategy to access it.
-     *
-     * @var EE_Display_Strategy_Base
-     */
-    private $_display_strategy;
-
-    /**
-     * Gets all the validation strategies used on this field
-     *
-     * @var EE_Validation_Strategy_Base[]
-     */
-    private $_validation_strategies = array();
-
-    /**
-     * The normalization strategy for this field
-     *
-     * @var EE_Normalization_Strategy_Base
-     */
-    private $_normalization_strategy;
-
-    /**
-     * Strategy for removing sensitive data after we're done with the form input
-     *
-     * @var EE_Sensitive_Data_Removal_Base
-     */
-    protected $_sensitive_data_removal_strategy;
-
-
-
-    /**
-     * @param array                         $input_args       {
-     * @type string                         $html_name        the html name for the input
-     * @type string                         $html_label_id    the id attribute to give to the html label tag
-     * @type string                         $html_label_class the class attribute to give to the html label tag
-     * @type string                         $html_label_style the style attribute to give ot teh label tag
-     * @type string                         $html_label_text  the text to put in the label tag
-     * @type string                         $html_label       the full html label. If used,
-     *                                                        all other html_label_* args are invalid
-     * @type string                         $html_help_text   text to put in help element
-     * @type string                         $html_help_style  style attribute to give to teh help element
-     * @type string                         $html_help_class  class attribute to give to the help element
-     * @type string                         $default          default value NORMALIZED (eg, if providing the default
-     *       for a Yes_No_Input, you should provide TRUE or FALSE, not '1' or '0')
-     * @type EE_Display_Strategy_Base       $display          strategy
-     * @type EE_Normalization_Strategy_Base $normalization_strategy
-     * @type EE_Validation_Strategy_Base[]  $validation_strategies
-     *                                                        }
-     */
-    public function __construct($input_args = array())
-    {
-        $input_args = (array)apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
-        // the following properties must be cast as arrays
-        if (isset($input_args['validation_strategies'])) {
-            foreach ((array)$input_args['validation_strategies'] as $validation_strategy) {
-                if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
-                    $this->_validation_strategies[get_class($validation_strategy)] = $validation_strategy;
-                }
-            }
-            unset($input_args['validation_strategies']);
-        }
-        // loop thru incoming options
-        foreach ($input_args as $key => $value) {
-            // add underscore to $key to match property names
-            $_key = '_' . $key;
-            if (property_exists($this, $_key)) {
-                $this->{$_key} = $value;
-            }
-        }
-        // ensure that "required" is set correctly
-        $this->set_required(
-            $this->_required, isset($input_args['required_validation_error_message'])
-            ? $input_args['required_validation_error_message']
-            : null
-        );
-        //$this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
-        $this->_display_strategy->_construct_finalize($this);
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            $validation_strategy->_construct_finalize($this);
-        }
-        if (! $this->_normalization_strategy) {
-            $this->_normalization_strategy = new EE_Text_Normalization();
-        }
-        $this->_normalization_strategy->_construct_finalize($this);
-        //at least we can use the normalization strategy to populate the default
-        if (isset($input_args['default'])) {
-            $this->set_default($input_args['default']);
-        }
-        if (! $this->_sensitive_data_removal_strategy) {
-            $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
-        }
-        $this->_sensitive_data_removal_strategy->_construct_finalize($this);
-        parent::__construct($input_args);
-    }
-
-
-
-    /**
-     * Sets the html_name to its default value, if none was specified in teh constructor.
-     * Calculation involves using the name and the parent's html_name
-     *
-     * @throws \EE_Error
-     */
-    protected function _set_default_html_name_if_empty()
-    {
-        if (! $this->_html_name) {
-            $this->_html_name = $this->name();
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
-            }
-        }
-    }
-
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws \EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        if ($this->_html_label === null && $this->_html_label_text === null) {
-            $this->_html_label_text = ucwords(str_replace("_", " ", $name));
-        }
-        do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
-    }
-
-
-
-    /**
-     * Returns the strategy for displaying this form input. If none is set, throws an exception.
-     *
-     * @return EE_Display_Strategy_Base
-     * @throws EE_Error
-     */
-    protected function _get_display_strategy()
-    {
-        $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
-                        "event_espresso"
-                    ),
-                    $this->html_name(),
-                    $this->html_id()
-                )
-            );
-        } else {
-            return $this->_display_strategy;
-        }
-    }
-
-
-
-    /**
-     * Sets the display strategy.
-     *
-     * @param EE_Display_Strategy_Base $strategy
-     */
-    protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
-    {
-        $this->_display_strategy = $strategy;
-    }
-
-
-
-    /**
-     * Sets the sanitization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $strategy
-     */
-    protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
-    {
-        $this->_normalization_strategy = $strategy;
-    }
-
-
-
-    /**
-     * Gets sensitive_data_removal_strategy
-     *
-     * @return EE_Sensitive_Data_Removal_Base
-     */
-    public function get_sensitive_data_removal_strategy()
-    {
-        return $this->_sensitive_data_removal_strategy;
-    }
-
-
-
-    /**
-     * Sets sensitive_data_removal_strategy
-     *
-     * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
-     * @return boolean
-     */
-    public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
-    {
-        $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
-    }
-
-
-
-    /**
-     * Gets the display strategy for this input
-     *
-     * @return EE_Display_Strategy_Base
-     */
-    public function get_display_strategy()
-    {
-        return $this->_display_strategy;
-    }
-
-
-
-    /**
-     * Overwrites the display strategy
-     *
-     * @param EE_Display_Strategy_Base $display_strategy
-     */
-    public function set_display_strategy($display_strategy)
-    {
-        $this->_display_strategy = $display_strategy;
-        $this->_display_strategy->_construct_finalize($this);
-    }
-
-
-
-    /**
-     * Gets the normalization strategy set on this input
-     *
-     * @return EE_Normalization_Strategy_Base
-     */
-    public function get_normalization_strategy()
-    {
-        return $this->_normalization_strategy;
-    }
-
-
-
-    /**
-     * Overwrites the normalization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $normalization_strategy
-     */
-    public function set_normalization_strategy($normalization_strategy)
-    {
-        $this->_normalization_strategy = $normalization_strategy;
-        $this->_normalization_strategy->_construct_finalize($this);
-    }
-
-
-
-    /**
-     * Returns all teh validation strategies which apply to this field, numerically indexed
-     *
-     * @return EE_Validation_Strategy_Base[]
-     */
-    public function get_validation_strategies()
-    {
-        return $this->_validation_strategies;
-    }
-
-
-
-    /**
-     * Adds this strategy to the field so it will be used in both JS validation and server-side validation
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $validation_strategy->_construct_finalize($this);
-        $this->_validation_strategies[] = $validation_strategy;
-    }
-
-
-
-    /**
-     * Adds a new validation strategy onto the form input
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $this->_add_validation_strategy($validation_strategy);
-    }
-
-
-
-    /**
-     * The classname of the validation strategy to remove
-     *
-     * @param string $validation_strategy_classname
-     */
-    public function remove_validation_strategy($validation_strategy_classname)
-    {
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (
-                $validation_strategy instanceof $validation_strategy_classname
-                || is_subclass_of($validation_strategy, $validation_strategy_classname)
-            ) {
-                unset($this->_validation_strategies[$key]);
-            }
-        }
-    }
-
-
-
-    /**
-     * returns true if input employs any of the validation strategy defined by the supplied array of classnames
-     *
-     * @param array $validation_strategy_classnames
-     * @return bool
-     */
-    public function has_validation_strategy($validation_strategy_classnames)
-    {
-        $validation_strategy_classnames = is_array($validation_strategy_classnames)
-            ? $validation_strategy_classnames
-            : array($validation_strategy_classnames);
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (in_array($key, $validation_strategy_classnames)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Gets the HTML
-     *
-     * @return string
-     */
-    public function get_html()
-    {
-        return $this->_parent_section->get_html_for_input($this);
-    }
-
-
-
-    /**
-     * Gets the HTML for the input itself (no label or errors) according to the
-     * input's display strategy
-     * Makes sure the JS and CSS are enqueued for it
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function get_html_for_input()
-    {
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml(
-                $this->_get_display_strategy()->display(),
-                $this
-            )
-            : $this->_get_display_strategy()->display();
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_other_attributes()
-    {
-        return ! empty($this->_html_other_attributes) ? ' ' . $this->_html_other_attributes : '';
-    }
-
-
-
-    /**
-     * @param string $html_other_attributes
-     */
-    public function set_html_other_attributes($html_other_attributes)
-    {
-        $this->_html_other_attributes = $html_other_attributes;
-    }
-
-
-
-    /**
-     * Gets the HTML for displaying the label for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_label()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_label($this);
-    }
-
-
-
-    /**
-     * Gets the HTML for displaying the errors section for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_errors()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_errors($this);
-    }
-
-
-
-    /**
-     * Gets the HTML for displaying the help text for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_help()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_help_text($this);
-    }
-
-
-
-    /**
-     * Validates the input's sanitized value (assumes _sanitize() has already been called)
-     * and returns whether or not the form input's submitted value is value
-     *
-     * @return boolean
-     */
-    protected function _validate()
-    {
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
-                try {
-                    $validation_strategy->validate($this->normalized_value());
-                } catch (EE_Validation_Error $e) {
-                    $this->add_validation_error($e);
-                }
-            }
-        }
-        if ($this->get_validation_errors()) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-
-    /**
-     * Performs basic sanitization on this value. But what sanitization can be performed anyways?
-     * This value MIGHT be allowed to have tags, so we can't really remove them.
-     *
-     * @param string $value
-     * @return null|string
-     */
-    private function _sanitize($value)
-    {
-        return $value !== null ? stripslashes(html_entity_decode(trim($value))) : null;
-    }
-
-
-
-    /**
-     * Picks out the form value that relates to this form input,
-     * and stores it as the sanitized value on the form input, and sets the normalized value.
-     * Returns whether or not any validation errors occurred
-     *
-     * @param array $req_data like $_POST
-     * @return boolean whether or not there was an error
-     * @throws \EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        //any existing validation errors don't apply so clear them
-        $this->_validation_errors = array();
-        try {
-            $raw_input = $this->find_form_data_for_this_section($req_data);
-            //super simple sanitization for now
-            if (is_array($raw_input)) {
-                $raw_value = array();
-                foreach ($raw_input as $key => $value) {
-                    $raw_value[$key] = $this->_sanitize($value);
-                }
-                $this->_set_raw_value($raw_value);
-            } else {
-                $this->_set_raw_value($this->_sanitize($raw_input));
-            }
-            //we want to mostly leave the input alone in case we need to re-display it to the user
-            $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
-        } catch (EE_Validation_Error $e) {
-            $this->add_validation_error($e);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_name()
-    {
-        $this->_set_default_html_name_if_empty();
-        return $this->_html_name;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_label_id()
-    {
-        return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->_html_id . '-lbl';
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_label_class()
-    {
-        return $this->_html_label_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_label_style()
-    {
-        return $this->_html_label_style;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_label_text()
-    {
-        return $this->_html_label_text;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_help_text()
-    {
-        return $this->_html_help_text;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_help_class()
-    {
-        return $this->_html_help_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function html_help_style()
-    {
-        return $this->_html_style;
-    }
-
-
-
-    /**
-     * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
-     * Please note that almost all client code should instead use the normalized_value;
-     * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
-     * mostly by escaping quotes)
-     * Note, we do not store the exact original value sent in the user's request because
-     * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
-     * in which case, we would have stored the malicious content to our database.
-     *
-     * @return string
-     */
-    public function raw_value()
-    {
-        return $this->_raw_value;
-    }
-
-
-
-    /**
-     * Returns a string safe to usage in form inputs when displaying, because
-     * it escapes all html entities
-     *
-     * @return string
-     */
-    public function raw_value_in_form()
-    {
-        return htmlentities($this->raw_value(), ENT_QUOTES, 'UTF-8');
-    }
-
-
-
-    /**
-     * returns the value after it's been sanitized, and then converted into it's proper type
-     * in PHP. Eg, a string, an int, an array,
-     *
-     * @return mixed
-     */
-    public function normalized_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-
-    /**
-     * Returns the normalized value is a presentable way. By default this is just
-     * the normalized value by itself, but it can be overridden for when that's not
-     * the best thing to display
-     *
-     * @return string
-     */
-    public function pretty_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * if this field had the name 'password_again', it should return
-     * <br><code>password_again: {
-     * equalTo: "#password"
-     * }</code>
-     *
-     * @return array
-     */
-    public function get_jquery_validation_rules()
-    {
-        $jquery_validation_js = array();
-        $jquery_validation_rules = array();
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $jquery_validation_rules = array_replace_recursive(
-                $jquery_validation_rules,
-                $validation_strategy->get_jquery_validation_rule_array()
-            );
-        }
-        if (! empty($jquery_validation_rules)) {
-            foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[$html_id_with_pound_sign] = $jquery_validation_rules;
-            }
-        }
-        return $jquery_validation_js;
-    }
-
-
-
-    /**
-     * Sets the input's default value for use in displaying in the form. Note: value should be
-     * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
-     *
-     * @param mixed $value
-     * @return void
-     */
-    public function set_default($value)
-    {
-        $this->_set_normalized_value($value);
-        $this->_set_raw_value($value);
-    }
-
-
-
-    /**
-     * Sets the normalized value on this input
-     *
-     * @param mixed $value
-     */
-    protected function _set_normalized_value($value)
-    {
-        $this->_normalized_value = $value;
-    }
-
-
-
-    /**
-     * Sets the raw value on this input (ie, exactly as the user submitted it)
-     *
-     * @param mixed $value
-     */
-    protected function _set_raw_value($value)
-    {
-        $this->_raw_value = $this->_normalization_strategy->unnormalize($value);
-    }
-
-
-
-    /**
-     * Sets the HTML label text after it has already been defined
-     *
-     * @param string $label
-     * @return void
-     */
-    public function set_html_label_text($label)
-    {
-        $this->_html_label_text = $label;
-    }
-
-
-
-    /**
-     * Sets whether or not this field is required, and adjusts the validation strategy.
-     * If you want to use the EE_Conditionally_Required_Validation_Strategy,
-     * please add it as a validation strategy using add_validation_strategy as normal
-     *
-     * @param boolean $required boolean
-     * @param null    $required_text
-     */
-    public function set_required($required = true, $required_text = null)
-    {
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
-        //whether $required is a string or a boolean, we want to add a required validation strategy
-        if ($required) {
-            $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
-        } else {
-            $this->remove_validation_strategy('EE_Required_Validation_Strategy');
-        }
-        $this->_required = $required;
-    }
-
-
-
-    /**
-     * Returns whether or not this field is required
-     *
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->_required;
-    }
-
-
-
-    /**
-     * @param string $required_css_class
-     */
-    public function set_required_css_class($required_css_class)
-    {
-        $this->_required_css_class = $required_css_class;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function required_css_class()
-    {
-        return $this->_required_css_class;
-    }
-
-
-
-    /**
-     * Sets the help text, in case
-     *
-     * @param string $text
-     */
-    public function set_html_help_text($text)
-    {
-        $this->_html_help_text = $text;
-    }
-
-
-
-    /**
-     * Uses the sensitive data removal strategy to remove the sensitive data from this
-     * input. If there is any kind of sensitive data removal on this input, we clear
-     * out the raw value completely
-     *
-     * @return void
-     */
-    public function clean_sensitive_data()
-    {
-        //if we do ANY kind of sensitive data removal on this, then just clear out the raw value
-        //if we need more logic than this we'll make a strategy for it
-        if ($this->_sensitive_data_removal_strategy
-            && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
-        ) {
-            $this->_set_raw_value(null);
-        }
-        //and clean the normalized value according to the appropriate strategy
-        $this->_set_normalized_value(
-            $this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
-                $this->_normalized_value
-            )
-        );
-    }
-
-
-
-    /**
-     * @param bool   $primary
-     * @param string $button_size
-     * @param string $other_attributes
-     */
-    public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
-    {
-        $button_css_attributes = 'button';
-        $button_css_attributes .= $primary === true ? ' button-primary' : ' button-secondary';
-        switch ($button_size) {
-            case 'xs' :
-            case 'extra-small' :
-                $button_css_attributes .= ' button-xs';
-                break;
-            case 'sm' :
-            case 'small' :
-                $button_css_attributes .= ' button-sm';
-                break;
-            case 'lg' :
-            case 'large' :
-                $button_css_attributes .= ' button-lg';
-                break;
-            case 'block' :
-                $button_css_attributes .= ' button-block';
-                break;
-            case 'md' :
-            case 'medium' :
-            default :
-                $button_css_attributes .= '';
-        }
-        $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
-            : $button_css_attributes;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function button_css_attributes()
-    {
-        if (empty($this->_button_css_attributes)) {
-            $this->set_button_css_attributes();
-        }
-        return $this->_button_css_attributes;
-    }
-
-
-
-    /**
-     * find_form_data_for_this_section
-     * using this section's name and its parents, finds the value of the form data that corresponds to it.
-     * For example, if this form section's HTML name is my_form[subform][form_input_1],
-     * then it's value should be in $_REQUEST at $_REQUEST['my_form']['subform']['form_input_1'].
-     * (If that doesn't exist, we also check for this subsection's name
-     * at the TOP LEVEL of the request data. Eg $_REQUEST['form_input_1'].)
-     * This function finds its value in the form.
-     *
-     * @param array $req_data
-     * @return mixed whatever the raw value of this form section is in the request data
-     * @throws \EE_Error
-     */
-    public function find_form_data_for_this_section($req_data)
-    {
-        // break up the html name by "[]"
-        if (strpos($this->html_name(), '[') !== false) {
-            $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
-        } else {
-            $before_any_brackets = $this->html_name();
-        }
-        // grab all of the segments
-        preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
-        if (isset($matches[1]) && is_array($matches[1])) {
-            $name_parts = $matches[1];
-            array_unshift($name_parts, $before_any_brackets);
-        } else {
-            $name_parts = array($before_any_brackets);
-        }
-        // now get the value for the input
-        $value = $this->_find_form_data_for_this_section_using_name_parts($name_parts, $req_data);
-        // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[$this->name()])) {
-            $value = $req_data[$this->name()];
-        }
-        return $value;
-    }
-
-
-
-    /**
-     * @param array $html_name_parts
-     * @param array $req_data
-     * @return array | NULL
-     */
-    public function _find_form_data_for_this_section_using_name_parts($html_name_parts, $req_data)
-    {
-        $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[$first_part_to_consider])) {
-            if (empty($html_name_parts)) {
-                return $req_data[$first_part_to_consider];
-            } else {
-                return $this->_find_form_data_for_this_section_using_name_parts(
-                    $html_name_parts,
-                    $req_data[$first_part_to_consider]
-                );
-            }
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * Checks if this form input's data is in the request data
-     *
-     * @param array $req_data like $_POST
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            $req_data = $_POST;
-        }
-        $checked_value = $this->find_form_data_for_this_section($req_data);
-        if ($checked_value !== null) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Overrides parent to add js data from validation and display strategies
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        $form_other_js_data = $this->get_other_js_data_from_strategies($form_other_js_data);
-        return $form_other_js_data;
-    }
-
-
-
-    /**
-     * Gets other JS data for localization from this input's strategies, like
-     * the validation strategies and the display strategy
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data_from_strategies($form_other_js_data = array())
-    {
-        $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-
-    /**
-     * Override parent because we want to give our strategies an opportunity to enqueue some js and css
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        //ask our display strategy and validation strategies if they have js to enqueue
-        $this->enqueue_js_from_strategies();
-    }
-
-
-
-    /**
-     * Tells strategies when its ok to enqueue their js and css
-     *
-     * @return void
-     */
-    public function enqueue_js_from_strategies()
-    {
-        $this->get_display_strategy()->enqueue_js();
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $validation_strategy->enqueue_js();
-        }
-    }
+	/**
+	 * the input's name attribute
+	 *
+	 * @var string
+	 */
+	protected $_html_name;
+
+	/**
+	 * id for the html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_id;
+
+	/**
+	 * class for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_class;
+
+	/**
+	 * any additional html attributes that you may want to add
+	 *
+	 * @var string
+	 */
+	protected $_html_other_attributes;
+
+	/**
+	 * style for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_style;
+
+	/**
+	 * text to be placed in the html label
+	 *
+	 * @var string
+	 */
+	protected $_html_label_text;
+
+	/**
+	 * the full html label. If used, all other html_label_* properties are invalid
+	 *
+	 * @var string
+	 */
+	protected $_html_label;
+
+	/**
+	 * HTML to use for help text (normally placed below form input), in a span which normally
+	 * has a class of 'description'
+	 *
+	 * @var string
+	 */
+	protected $_html_help_text;
+
+	/**
+	 * CSS classes for displaying the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_class = 'description';
+
+	/**
+	 * CSS to put in the style attribute on the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_style;
+
+	/**
+	 * Stores whether or not this input's response is required.
+	 * Because certain styling elements may also want to know that this
+	 * input is required etc.
+	 *
+	 * @var boolean
+	 */
+	protected $_required;
+
+	/**
+	 * css class added to required inputs
+	 *
+	 * @var string
+	 */
+	protected $_required_css_class = 'ee-required';
+
+	/**
+	 * css styles applied to button type inputs
+	 *
+	 * @var string
+	 */
+	protected $_button_css_attributes;
+
+	/**
+	 * The raw data submitted for this, like in the $_POST super global.
+	 * Generally unsafe for usage in client code
+	 *
+	 * @var mixed string or array
+	 */
+	protected $_raw_value;
+
+	/**
+	 * Value normalized according to the input's normalization strategy.
+	 * The normalization strategy dictates whether this is a string, int, float,
+	 * boolean, or array of any of those.
+	 *
+	 * @var mixed
+	 */
+	protected $_normalized_value;
+
+	/**
+	 * Strategy used for displaying this field.
+	 * Child classes must use _get_display_strategy to access it.
+	 *
+	 * @var EE_Display_Strategy_Base
+	 */
+	private $_display_strategy;
+
+	/**
+	 * Gets all the validation strategies used on this field
+	 *
+	 * @var EE_Validation_Strategy_Base[]
+	 */
+	private $_validation_strategies = array();
+
+	/**
+	 * The normalization strategy for this field
+	 *
+	 * @var EE_Normalization_Strategy_Base
+	 */
+	private $_normalization_strategy;
+
+	/**
+	 * Strategy for removing sensitive data after we're done with the form input
+	 *
+	 * @var EE_Sensitive_Data_Removal_Base
+	 */
+	protected $_sensitive_data_removal_strategy;
+
+
+
+	/**
+	 * @param array                         $input_args       {
+	 * @type string                         $html_name        the html name for the input
+	 * @type string                         $html_label_id    the id attribute to give to the html label tag
+	 * @type string                         $html_label_class the class attribute to give to the html label tag
+	 * @type string                         $html_label_style the style attribute to give ot teh label tag
+	 * @type string                         $html_label_text  the text to put in the label tag
+	 * @type string                         $html_label       the full html label. If used,
+	 *                                                        all other html_label_* args are invalid
+	 * @type string                         $html_help_text   text to put in help element
+	 * @type string                         $html_help_style  style attribute to give to teh help element
+	 * @type string                         $html_help_class  class attribute to give to the help element
+	 * @type string                         $default          default value NORMALIZED (eg, if providing the default
+	 *       for a Yes_No_Input, you should provide TRUE or FALSE, not '1' or '0')
+	 * @type EE_Display_Strategy_Base       $display          strategy
+	 * @type EE_Normalization_Strategy_Base $normalization_strategy
+	 * @type EE_Validation_Strategy_Base[]  $validation_strategies
+	 *                                                        }
+	 */
+	public function __construct($input_args = array())
+	{
+		$input_args = (array)apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
+		// the following properties must be cast as arrays
+		if (isset($input_args['validation_strategies'])) {
+			foreach ((array)$input_args['validation_strategies'] as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
+					$this->_validation_strategies[get_class($validation_strategy)] = $validation_strategy;
+				}
+			}
+			unset($input_args['validation_strategies']);
+		}
+		// loop thru incoming options
+		foreach ($input_args as $key => $value) {
+			// add underscore to $key to match property names
+			$_key = '_' . $key;
+			if (property_exists($this, $_key)) {
+				$this->{$_key} = $value;
+			}
+		}
+		// ensure that "required" is set correctly
+		$this->set_required(
+			$this->_required, isset($input_args['required_validation_error_message'])
+			? $input_args['required_validation_error_message']
+			: null
+		);
+		//$this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
+		$this->_display_strategy->_construct_finalize($this);
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			$validation_strategy->_construct_finalize($this);
+		}
+		if (! $this->_normalization_strategy) {
+			$this->_normalization_strategy = new EE_Text_Normalization();
+		}
+		$this->_normalization_strategy->_construct_finalize($this);
+		//at least we can use the normalization strategy to populate the default
+		if (isset($input_args['default'])) {
+			$this->set_default($input_args['default']);
+		}
+		if (! $this->_sensitive_data_removal_strategy) {
+			$this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
+		}
+		$this->_sensitive_data_removal_strategy->_construct_finalize($this);
+		parent::__construct($input_args);
+	}
+
+
+
+	/**
+	 * Sets the html_name to its default value, if none was specified in teh constructor.
+	 * Calculation involves using the name and the parent's html_name
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _set_default_html_name_if_empty()
+	{
+		if (! $this->_html_name) {
+			$this->_html_name = $this->name();
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+			}
+		}
+	}
+
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws \EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		if ($this->_html_label === null && $this->_html_label_text === null) {
+			$this->_html_label_text = ucwords(str_replace("_", " ", $name));
+		}
+		do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
+	}
+
+
+
+	/**
+	 * Returns the strategy for displaying this form input. If none is set, throws an exception.
+	 *
+	 * @return EE_Display_Strategy_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_display_strategy()
+	{
+		$this->ensure_construct_finalized_called();
+		if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
+						"event_espresso"
+					),
+					$this->html_name(),
+					$this->html_id()
+				)
+			);
+		} else {
+			return $this->_display_strategy;
+		}
+	}
+
+
+
+	/**
+	 * Sets the display strategy.
+	 *
+	 * @param EE_Display_Strategy_Base $strategy
+	 */
+	protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
+	{
+		$this->_display_strategy = $strategy;
+	}
+
+
+
+	/**
+	 * Sets the sanitization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $strategy
+	 */
+	protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
+	{
+		$this->_normalization_strategy = $strategy;
+	}
+
+
+
+	/**
+	 * Gets sensitive_data_removal_strategy
+	 *
+	 * @return EE_Sensitive_Data_Removal_Base
+	 */
+	public function get_sensitive_data_removal_strategy()
+	{
+		return $this->_sensitive_data_removal_strategy;
+	}
+
+
+
+	/**
+	 * Sets sensitive_data_removal_strategy
+	 *
+	 * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
+	 * @return boolean
+	 */
+	public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
+	{
+		$this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
+	}
+
+
+
+	/**
+	 * Gets the display strategy for this input
+	 *
+	 * @return EE_Display_Strategy_Base
+	 */
+	public function get_display_strategy()
+	{
+		return $this->_display_strategy;
+	}
+
+
+
+	/**
+	 * Overwrites the display strategy
+	 *
+	 * @param EE_Display_Strategy_Base $display_strategy
+	 */
+	public function set_display_strategy($display_strategy)
+	{
+		$this->_display_strategy = $display_strategy;
+		$this->_display_strategy->_construct_finalize($this);
+	}
+
+
+
+	/**
+	 * Gets the normalization strategy set on this input
+	 *
+	 * @return EE_Normalization_Strategy_Base
+	 */
+	public function get_normalization_strategy()
+	{
+		return $this->_normalization_strategy;
+	}
+
+
+
+	/**
+	 * Overwrites the normalization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $normalization_strategy
+	 */
+	public function set_normalization_strategy($normalization_strategy)
+	{
+		$this->_normalization_strategy = $normalization_strategy;
+		$this->_normalization_strategy->_construct_finalize($this);
+	}
+
+
+
+	/**
+	 * Returns all teh validation strategies which apply to this field, numerically indexed
+	 *
+	 * @return EE_Validation_Strategy_Base[]
+	 */
+	public function get_validation_strategies()
+	{
+		return $this->_validation_strategies;
+	}
+
+
+
+	/**
+	 * Adds this strategy to the field so it will be used in both JS validation and server-side validation
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$validation_strategy->_construct_finalize($this);
+		$this->_validation_strategies[] = $validation_strategy;
+	}
+
+
+
+	/**
+	 * Adds a new validation strategy onto the form input
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$this->_add_validation_strategy($validation_strategy);
+	}
+
+
+
+	/**
+	 * The classname of the validation strategy to remove
+	 *
+	 * @param string $validation_strategy_classname
+	 */
+	public function remove_validation_strategy($validation_strategy_classname)
+	{
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (
+				$validation_strategy instanceof $validation_strategy_classname
+				|| is_subclass_of($validation_strategy, $validation_strategy_classname)
+			) {
+				unset($this->_validation_strategies[$key]);
+			}
+		}
+	}
+
+
+
+	/**
+	 * returns true if input employs any of the validation strategy defined by the supplied array of classnames
+	 *
+	 * @param array $validation_strategy_classnames
+	 * @return bool
+	 */
+	public function has_validation_strategy($validation_strategy_classnames)
+	{
+		$validation_strategy_classnames = is_array($validation_strategy_classnames)
+			? $validation_strategy_classnames
+			: array($validation_strategy_classnames);
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (in_array($key, $validation_strategy_classnames)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Gets the HTML
+	 *
+	 * @return string
+	 */
+	public function get_html()
+	{
+		return $this->_parent_section->get_html_for_input($this);
+	}
+
+
+
+	/**
+	 * Gets the HTML for the input itself (no label or errors) according to the
+	 * input's display strategy
+	 * Makes sure the JS and CSS are enqueued for it
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function get_html_for_input()
+	{
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml(
+				$this->_get_display_strategy()->display(),
+				$this
+			)
+			: $this->_get_display_strategy()->display();
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_other_attributes()
+	{
+		return ! empty($this->_html_other_attributes) ? ' ' . $this->_html_other_attributes : '';
+	}
+
+
+
+	/**
+	 * @param string $html_other_attributes
+	 */
+	public function set_html_other_attributes($html_other_attributes)
+	{
+		$this->_html_other_attributes = $html_other_attributes;
+	}
+
+
+
+	/**
+	 * Gets the HTML for displaying the label for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_label()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_label($this);
+	}
+
+
+
+	/**
+	 * Gets the HTML for displaying the errors section for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_errors()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_errors($this);
+	}
+
+
+
+	/**
+	 * Gets the HTML for displaying the help text for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_help()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_help_text($this);
+	}
+
+
+
+	/**
+	 * Validates the input's sanitized value (assumes _sanitize() has already been called)
+	 * and returns whether or not the form input's submitted value is value
+	 *
+	 * @return boolean
+	 */
+	protected function _validate()
+	{
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
+				try {
+					$validation_strategy->validate($this->normalized_value());
+				} catch (EE_Validation_Error $e) {
+					$this->add_validation_error($e);
+				}
+			}
+		}
+		if ($this->get_validation_errors()) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on this value. But what sanitization can be performed anyways?
+	 * This value MIGHT be allowed to have tags, so we can't really remove them.
+	 *
+	 * @param string $value
+	 * @return null|string
+	 */
+	private function _sanitize($value)
+	{
+		return $value !== null ? stripslashes(html_entity_decode(trim($value))) : null;
+	}
+
+
+
+	/**
+	 * Picks out the form value that relates to this form input,
+	 * and stores it as the sanitized value on the form input, and sets the normalized value.
+	 * Returns whether or not any validation errors occurred
+	 *
+	 * @param array $req_data like $_POST
+	 * @return boolean whether or not there was an error
+	 * @throws \EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		//any existing validation errors don't apply so clear them
+		$this->_validation_errors = array();
+		try {
+			$raw_input = $this->find_form_data_for_this_section($req_data);
+			//super simple sanitization for now
+			if (is_array($raw_input)) {
+				$raw_value = array();
+				foreach ($raw_input as $key => $value) {
+					$raw_value[$key] = $this->_sanitize($value);
+				}
+				$this->_set_raw_value($raw_value);
+			} else {
+				$this->_set_raw_value($this->_sanitize($raw_input));
+			}
+			//we want to mostly leave the input alone in case we need to re-display it to the user
+			$this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
+		} catch (EE_Validation_Error $e) {
+			$this->add_validation_error($e);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_name()
+	{
+		$this->_set_default_html_name_if_empty();
+		return $this->_html_name;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_id()
+	{
+		return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->_html_id . '-lbl';
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_class()
+	{
+		return $this->_html_label_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_style()
+	{
+		return $this->_html_label_style;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_text()
+	{
+		return $this->_html_label_text;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_text()
+	{
+		return $this->_html_help_text;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_class()
+	{
+		return $this->_html_help_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_style()
+	{
+		return $this->_html_style;
+	}
+
+
+
+	/**
+	 * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
+	 * Please note that almost all client code should instead use the normalized_value;
+	 * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
+	 * mostly by escaping quotes)
+	 * Note, we do not store the exact original value sent in the user's request because
+	 * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
+	 * in which case, we would have stored the malicious content to our database.
+	 *
+	 * @return string
+	 */
+	public function raw_value()
+	{
+		return $this->_raw_value;
+	}
+
+
+
+	/**
+	 * Returns a string safe to usage in form inputs when displaying, because
+	 * it escapes all html entities
+	 *
+	 * @return string
+	 */
+	public function raw_value_in_form()
+	{
+		return htmlentities($this->raw_value(), ENT_QUOTES, 'UTF-8');
+	}
+
+
+
+	/**
+	 * returns the value after it's been sanitized, and then converted into it's proper type
+	 * in PHP. Eg, a string, an int, an array,
+	 *
+	 * @return mixed
+	 */
+	public function normalized_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+
+	/**
+	 * Returns the normalized value is a presentable way. By default this is just
+	 * the normalized value by itself, but it can be overridden for when that's not
+	 * the best thing to display
+	 *
+	 * @return string
+	 */
+	public function pretty_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * if this field had the name 'password_again', it should return
+	 * <br><code>password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 *
+	 * @return array
+	 */
+	public function get_jquery_validation_rules()
+	{
+		$jquery_validation_js = array();
+		$jquery_validation_rules = array();
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$jquery_validation_rules = array_replace_recursive(
+				$jquery_validation_rules,
+				$validation_strategy->get_jquery_validation_rule_array()
+			);
+		}
+		if (! empty($jquery_validation_rules)) {
+			foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
+				$jquery_validation_js[$html_id_with_pound_sign] = $jquery_validation_rules;
+			}
+		}
+		return $jquery_validation_js;
+	}
+
+
+
+	/**
+	 * Sets the input's default value for use in displaying in the form. Note: value should be
+	 * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
+	 *
+	 * @param mixed $value
+	 * @return void
+	 */
+	public function set_default($value)
+	{
+		$this->_set_normalized_value($value);
+		$this->_set_raw_value($value);
+	}
+
+
+
+	/**
+	 * Sets the normalized value on this input
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_normalized_value($value)
+	{
+		$this->_normalized_value = $value;
+	}
+
+
+
+	/**
+	 * Sets the raw value on this input (ie, exactly as the user submitted it)
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_raw_value($value)
+	{
+		$this->_raw_value = $this->_normalization_strategy->unnormalize($value);
+	}
+
+
+
+	/**
+	 * Sets the HTML label text after it has already been defined
+	 *
+	 * @param string $label
+	 * @return void
+	 */
+	public function set_html_label_text($label)
+	{
+		$this->_html_label_text = $label;
+	}
+
+
+
+	/**
+	 * Sets whether or not this field is required, and adjusts the validation strategy.
+	 * If you want to use the EE_Conditionally_Required_Validation_Strategy,
+	 * please add it as a validation strategy using add_validation_strategy as normal
+	 *
+	 * @param boolean $required boolean
+	 * @param null    $required_text
+	 */
+	public function set_required($required = true, $required_text = null)
+	{
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
+		//whether $required is a string or a boolean, we want to add a required validation strategy
+		if ($required) {
+			$this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
+		} else {
+			$this->remove_validation_strategy('EE_Required_Validation_Strategy');
+		}
+		$this->_required = $required;
+	}
+
+
+
+	/**
+	 * Returns whether or not this field is required
+	 *
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->_required;
+	}
+
+
+
+	/**
+	 * @param string $required_css_class
+	 */
+	public function set_required_css_class($required_css_class)
+	{
+		$this->_required_css_class = $required_css_class;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function required_css_class()
+	{
+		return $this->_required_css_class;
+	}
+
+
+
+	/**
+	 * Sets the help text, in case
+	 *
+	 * @param string $text
+	 */
+	public function set_html_help_text($text)
+	{
+		$this->_html_help_text = $text;
+	}
+
+
+
+	/**
+	 * Uses the sensitive data removal strategy to remove the sensitive data from this
+	 * input. If there is any kind of sensitive data removal on this input, we clear
+	 * out the raw value completely
+	 *
+	 * @return void
+	 */
+	public function clean_sensitive_data()
+	{
+		//if we do ANY kind of sensitive data removal on this, then just clear out the raw value
+		//if we need more logic than this we'll make a strategy for it
+		if ($this->_sensitive_data_removal_strategy
+			&& ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
+		) {
+			$this->_set_raw_value(null);
+		}
+		//and clean the normalized value according to the appropriate strategy
+		$this->_set_normalized_value(
+			$this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
+				$this->_normalized_value
+			)
+		);
+	}
+
+
+
+	/**
+	 * @param bool   $primary
+	 * @param string $button_size
+	 * @param string $other_attributes
+	 */
+	public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
+	{
+		$button_css_attributes = 'button';
+		$button_css_attributes .= $primary === true ? ' button-primary' : ' button-secondary';
+		switch ($button_size) {
+			case 'xs' :
+			case 'extra-small' :
+				$button_css_attributes .= ' button-xs';
+				break;
+			case 'sm' :
+			case 'small' :
+				$button_css_attributes .= ' button-sm';
+				break;
+			case 'lg' :
+			case 'large' :
+				$button_css_attributes .= ' button-lg';
+				break;
+			case 'block' :
+				$button_css_attributes .= ' button-block';
+				break;
+			case 'md' :
+			case 'medium' :
+			default :
+				$button_css_attributes .= '';
+		}
+		$this->_button_css_attributes .= ! empty($other_attributes)
+			? $button_css_attributes . ' ' . $other_attributes
+			: $button_css_attributes;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function button_css_attributes()
+	{
+		if (empty($this->_button_css_attributes)) {
+			$this->set_button_css_attributes();
+		}
+		return $this->_button_css_attributes;
+	}
+
+
+
+	/**
+	 * find_form_data_for_this_section
+	 * using this section's name and its parents, finds the value of the form data that corresponds to it.
+	 * For example, if this form section's HTML name is my_form[subform][form_input_1],
+	 * then it's value should be in $_REQUEST at $_REQUEST['my_form']['subform']['form_input_1'].
+	 * (If that doesn't exist, we also check for this subsection's name
+	 * at the TOP LEVEL of the request data. Eg $_REQUEST['form_input_1'].)
+	 * This function finds its value in the form.
+	 *
+	 * @param array $req_data
+	 * @return mixed whatever the raw value of this form section is in the request data
+	 * @throws \EE_Error
+	 */
+	public function find_form_data_for_this_section($req_data)
+	{
+		// break up the html name by "[]"
+		if (strpos($this->html_name(), '[') !== false) {
+			$before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
+		} else {
+			$before_any_brackets = $this->html_name();
+		}
+		// grab all of the segments
+		preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
+		if (isset($matches[1]) && is_array($matches[1])) {
+			$name_parts = $matches[1];
+			array_unshift($name_parts, $before_any_brackets);
+		} else {
+			$name_parts = array($before_any_brackets);
+		}
+		// now get the value for the input
+		$value = $this->_find_form_data_for_this_section_using_name_parts($name_parts, $req_data);
+		// check if this thing's name is at the TOP level of the request data
+		if ($value === null && isset($req_data[$this->name()])) {
+			$value = $req_data[$this->name()];
+		}
+		return $value;
+	}
+
+
+
+	/**
+	 * @param array $html_name_parts
+	 * @param array $req_data
+	 * @return array | NULL
+	 */
+	public function _find_form_data_for_this_section_using_name_parts($html_name_parts, $req_data)
+	{
+		$first_part_to_consider = array_shift($html_name_parts);
+		if (isset($req_data[$first_part_to_consider])) {
+			if (empty($html_name_parts)) {
+				return $req_data[$first_part_to_consider];
+			} else {
+				return $this->_find_form_data_for_this_section_using_name_parts(
+					$html_name_parts,
+					$req_data[$first_part_to_consider]
+				);
+			}
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * Checks if this form input's data is in the request data
+	 *
+	 * @param array $req_data like $_POST
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			$req_data = $_POST;
+		}
+		$checked_value = $this->find_form_data_for_this_section($req_data);
+		if ($checked_value !== null) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent to add js data from validation and display strategies
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		$form_other_js_data = $this->get_other_js_data_from_strategies($form_other_js_data);
+		return $form_other_js_data;
+	}
+
+
+
+	/**
+	 * Gets other JS data for localization from this input's strategies, like
+	 * the validation strategies and the display strategy
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data_from_strategies($form_other_js_data = array())
+	{
+		$form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+
+	/**
+	 * Override parent because we want to give our strategies an opportunity to enqueue some js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		//ask our display strategy and validation strategies if they have js to enqueue
+		$this->enqueue_js_from_strategies();
+	}
+
+
+
+	/**
+	 * Tells strategies when its ok to enqueue their js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js_from_strategies()
+	{
+		$this->get_display_strategy()->enqueue_js();
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$validation_strategy->enqueue_js();
+		}
+	}
 }

core/business/EE_Transaction_Processor.class.php

Indentation +45 added lines, -46 removed lines

@@ -7,8 +7,7 @@ 
  * the interaction of EE_Transaction and EE_Registration model objects
  * Provides methods for manipulating and processing changes to an EE_Transaction
  * and it's related EE_Registrations with regards to the checkout/registration process
-
-*
+ *
 *@package     Event Espresso
  * @subpackage 	core
  * @author      Brent Christensen
@@ -177,24 +176,24 @@ 
 
 
 
-    /**
-     * update_transaction_and_registrations_after_checkout_or_payment
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
-     *
-     * @param EE_Transaction $transaction
-     * @param \EE_Payment | NULL $payment
-     * @param array              $registration_query_params    array of query WHERE params to use
-     *                                                         when retrieving cached registrations from a transaction
-     * @param bool $trigger_notifications                      whether or not to call
-     *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
-     * @return array
-     * @throws \EE_Error
-     */
+	/**
+	 * update_transaction_and_registrations_after_checkout_or_payment
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param \EE_Payment | NULL $payment
+	 * @param array              $registration_query_params    array of query WHERE params to use
+	 *                                                         when retrieving cached registrations from a transaction
+	 * @param bool $trigger_notifications                      whether or not to call
+	 *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+	 * @return array
+	 * @throws \EE_Error
+	 */
 	public function update_transaction_and_registrations_after_checkout_or_payment(
 		EE_Transaction $transaction,
 		$payment = null,
 		$registration_query_params = array(),
-        $trigger_notifications = true
+		$trigger_notifications = true
 	) {
 		// make sure some query params are set for retrieving registrations
 		$this->_set_registration_query_params( $registration_query_params );
@@ -224,15 +223,15 @@ 
 			$update_params
 		);
 		if ($trigger_notifications) {
-            // send messages
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->trigger_registration_update_notifications(
-                $transaction->primary_registration(),
-                $update_params
-            );
-        }
-        do_action(
+			// send messages
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->trigger_registration_update_notifications(
+				$transaction->primary_registration(),
+				$update_params
+			);
+		}
+		do_action(
 			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
 			$transaction,
 			$update_params
@@ -242,17 +241,17 @@ 
 
 
 
-    /**
-     * update_transaction_after_registration_reopened
-     * readjusts TXN and Line Item totals after a registration is changed from
-     * cancelled or declined to another reg status such as pending payment or approved
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
+	/**
+	 * update_transaction_after_registration_reopened
+	 * readjusts TXN and Line Item totals after a registration is changed from
+	 * cancelled or declined to another reg status such as pending payment or approved
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
 	public function update_transaction_after_reinstating_canceled_registration(
 		EE_Registration $registration,
 		$closed_reg_statuses = array(),
@@ -314,15 +313,15 @@ 
 		try {
 			$transaction = $this->get_transaction_for_registration( $registration );
 			if (
-			    apply_filters(
-                    'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
-                    true,
-                    $registration,
-                    $transaction
-                )
-            ){
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
-                EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
+				apply_filters(
+					'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
+					true,
+					$registration,
+					$transaction
+				)
+			){
+				$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
+				EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
 			}
 		} catch ( EE_Error $e ) {
 			EE_Error::add_error(
@@ -532,7 +531,7 @@ 
 						foreach ( $available_payment_methods as $available_payment_method ) {
 							if (
 								$available_payment_method instanceof EE_Payment_Method
-							    && $available_payment_method->open_by_default()
+								&& $available_payment_method->open_by_default()
 							) {
 								$PMD_ID = $available_payment_method->ID();
 								break;

Spacing +86 added lines, -86 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Transaction_Processor
@@ -50,10 +50,10 @@ 
 	 * @param array $registration_query_params
 	 *@return EE_Transaction_Processor instance
 	 */
-	public static function instance( $registration_query_params = array() ) {
+	public static function instance($registration_query_params = array()) {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Transaction_Processor ) {
-			self::$_instance = new self( $registration_query_params );
+		if ( ! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
 		}
 		return self::$_instance;
 	}
@@ -63,9 +63,9 @@ 
 	/**
 	 * @param array $registration_query_params
 	 */
-	private function __construct( $registration_query_params = array() ) {
+	private function __construct($registration_query_params = array()) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 	}
 
 
@@ -74,8 +74,8 @@ 
 	 * @access private
 	 * @param array $registration_query_params
 	 */
-	private function _set_registration_query_params( $registration_query_params ) {
-		$this->_registration_query_params = ! empty( $registration_query_params ) ? $registration_query_params : array( 'order_by' => array( 'REG_count' => 'ASC' ));
+	private function _set_registration_query_params($registration_query_params) {
+		$this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params : array('order_by' => array('REG_count' => 'ASC'));
 	}
 
 
@@ -104,10 +104,10 @@ 
 		);
 		// send messages
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		$registration_processor->trigger_registration_update_notifications(
 			$transaction->primary_registration(),
-			array( 'manually_updated' 	=> true )
+			array('manually_updated' 	=> true)
 		);
 		do_action(
 			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
@@ -197,13 +197,13 @@ 
         $trigger_notifications = true
 	) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// get final reg step status
 		$finalized = $transaction->final_reg_step_completed();
 		// if the 'finalize_registration' step has been initiated (has a timestamp)
 		// but has not yet been fully completed (TRUE)
-		if ( is_int( $finalized ) && $finalized !== false && $finalized !== true ) {
-			$transaction->set_reg_step_completed( 'finalize_registration' );
+		if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+			$transaction->set_reg_step_completed('finalize_registration');
 			$finalized = true;
 		}
 		$transaction->save();
@@ -259,22 +259,22 @@ 
 		$update_txn = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
-		if ( in_array( $registration->status_ID(), $closed_reg_statuses, true ) ) {
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
 			return false;
 		}
 		try {
-			$transaction = $this->get_transaction_for_registration( $registration );
+			$transaction = $this->get_transaction_for_registration($registration);
 			$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
 				$transaction,
 				$registration
 			);
 			// un-cancel the ticket
-			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item( $ticket_line_item );
-		} catch ( EE_Error $e ) {
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
+		} catch (EE_Error $e) {
 			EE_Error::add_error(
 				sprintf(
-					__( 'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s', 'event_espresso' ),
+					__('The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s', 'event_espresso'),
 					$registration->ID(),
 					'<br />',
 					$e->getMessage()
@@ -283,7 +283,7 @@ 
 			);
 			return false;
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? $success : false;
 		}
 		return $success;
@@ -307,12 +307,12 @@ 
 		$update_txn = true
 	) {
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
-		if ( ! in_array( $registration->status_ID(), $closed_reg_statuses, true ) ) {
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
 			return false;
 		}
 		try {
-			$transaction = $this->get_transaction_for_registration( $registration );
+			$transaction = $this->get_transaction_for_registration($registration);
 			if (
 			    apply_filters(
                     'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
@@ -320,14 +320,14 @@ 
                     $registration,
                     $transaction
                 )
-            ){
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration( $transaction, $registration );
-                EEH_Line_Item::cancel_ticket_line_item( $ticket_line_item );
+            ) {
+                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration($transaction, $registration);
+                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
 			}
-		} catch ( EE_Error $e ) {
+		} catch (EE_Error $e) {
 			EE_Error::add_error(
 				sprintf(
-					__( 'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s', 'event_espresso' ),
+					__('The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s', 'event_espresso'),
 					$registration->ID(),
 					'<br />',
 					$e->getMessage()
@@ -336,7 +336,7 @@ 
 			);
 			return false;
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? true : false;
 		}
 		return true;
@@ -352,12 +352,12 @@ 
 	 * @return 	EE_Transaction
 	 * @throws 	EE_Error
 	 */
-	public function get_transaction_for_registration( EE_Registration $registration ) {
+	public function get_transaction_for_registration(EE_Registration $registration) {
 		$transaction = $registration->transaction();
-		if ( ! $transaction instanceof EE_Transaction ) {
+		if ( ! $transaction instanceof EE_Transaction) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso' ),
+					__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
 					$registration->ID()
 				)
 			);
@@ -380,16 +380,16 @@ 
 		EE_Transaction $transaction,
 		EE_Registration $registration
 	) {
-		EE_Registry::instance()->load_helper( 'Line_Item' );
+		EE_Registry::instance()->load_helper('Line_Item');
 		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
 			$transaction->ID(),
 			$registration->ticket_ID()
 		);
-		if ( ! $ticket_line_item instanceof EE_Line_Item ) {
+		if ( ! $ticket_line_item instanceof EE_Line_Item) {
 			throw new EE_Error(
 				sprintf(
-					__( 'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-						'event_espresso' ),
+					__('The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+						'event_espresso'),
 					$transaction->ID(),
 					$registration->ticket_ID()
 				)
@@ -422,22 +422,22 @@ 
 		$update_txn = true
 	) {
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// these reg statuses should not be considered in any calculations involving monies owing
-		$closed_reg_statuses = ! empty( $closed_reg_statuses ) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses : EEM_Registration::closed_reg_statuses();
 		// loop through cached registrations
-		foreach ( $transaction->registrations( $this->_registration_query_params ) as $registration ) {
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
 			if (
 				$registration instanceof EE_Registration
-				&& ! in_array( $registration->status_ID(), $closed_reg_statuses )
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
 			) {
 				return false;
 			}
 		}
-		if ( in_array( $new_TXN_status, EEM_Transaction::txn_status_array() ) ) {
-			$transaction->set_status( $new_TXN_status );
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
+			$transaction->set_status($new_TXN_status);
 		}
-		if ( $update_txn ) {
+		if ($update_txn) {
 			return $transaction->save() ? true : false;
 		}
 		return true;
@@ -466,22 +466,22 @@ 
 	) {
 		$response = false;
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		// check that method exists
-		if ( ! method_exists( $registration_processor, $method_name )) {
-			throw new EE_Error( __( 'Method does not exist.', 'event_espresso' ));
+		if ( ! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(__('Method does not exist.', 'event_espresso'));
 		}
 		// make sure some query params are set for retrieving registrations
-		$this->_set_registration_query_params( $registration_query_params );
+		$this->_set_registration_query_params($registration_query_params);
 		// loop through cached registrations
-		foreach ( $transaction->registrations( $this->_registration_query_params ) as $registration ) {
-			if ( $registration instanceof EE_Registration ) {
-				if ( $additional_param ) {
-					$response = $registration_processor->{$method_name}( $registration, $additional_param )
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
 						? true
 						: $response;
 				} else {
-					$response = $registration_processor->{$method_name}( $registration )
+					$response = $registration_processor->{$method_name}($registration)
 						? true
 						: $response;
 				}
@@ -508,28 +508,28 @@ 
 	public function set_transaction_payment_method_based_on_registration_statuses(
 		EE_Registration $edited_registration
 	) {
-		if ( $edited_registration instanceof EE_Registration ) {
+		if ($edited_registration instanceof EE_Registration) {
 			$transaction = $edited_registration->transaction();
-			if ( $transaction instanceof EE_Transaction ) {
+			if ($transaction instanceof EE_Transaction) {
 				$all_not_approved = true;
-				foreach ( $transaction->registrations() as $registration ) {
-					if ( $registration instanceof EE_Registration ) {
+				foreach ($transaction->registrations() as $registration) {
+					if ($registration instanceof EE_Registration) {
 						// if any REG != "Not Approved" then toggle to false
 						$all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
 					}
 				}
 				// if ALL Registrations are "Not Approved"
-				if ( $all_not_approved ) {
-					$transaction->set_payment_method_ID( null );
+				if ($all_not_approved) {
+					$transaction->set_payment_method_ID(null);
 					$transaction->save();
 				} else {
 					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
 						$transaction,
 						EEM_Payment_Method::scope_cart
 					);
-					if ( ! empty( $available_payment_methods ) ) {
+					if ( ! empty($available_payment_methods)) {
 						$PMD_ID = 0;
-						foreach ( $available_payment_methods as $available_payment_method ) {
+						foreach ($available_payment_methods as $available_payment_method) {
 							if (
 								$available_payment_method instanceof EE_Payment_Method
 							    && $available_payment_method->open_by_default()
@@ -538,22 +538,22 @@ 
 								break;
 							}
 						}
-						if ( ! $PMD_ID ) {
-							$first_payment_method = reset( $available_payment_methods );
-							if ( $first_payment_method instanceof EE_Payment_Method ) {
+						if ( ! $PMD_ID) {
+							$first_payment_method = reset($available_payment_methods);
+							if ($first_payment_method instanceof EE_Payment_Method) {
 								$PMD_ID = $first_payment_method->ID();
 							} else {
 								EE_Error::add_error(
-									__( 'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso' ),
+									__('A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.', 'event_espresso'),
 									__FILE__, __LINE__, __FUNCTION__
 								);
 							}
 						}
-						$transaction->set_payment_method_ID( $PMD_ID );
+						$transaction->set_payment_method_ID($PMD_ID);
 						$transaction->save();
 					} else {
 						EE_Error::add_error(
-							__( 'Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso' ),
+							__('Please activate at least one Payment Method in order for things to operate correctly.', 'event_espresso'),
 							__FILE__, __LINE__, __FUNCTION__
 						);
 					}
@@ -590,7 +590,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $old_txn_status
 	 */
-	public function set_old_txn_status( $old_txn_status ) {
+	public function set_old_txn_status($old_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -600,7 +600,7 @@ 
 			'4.9.12'
 		);
 		// only set the first time
-		if ( $this->_old_txn_status === null ) {
+		if ($this->_old_txn_status === null) {
 			$this->_old_txn_status = $old_txn_status;
 		}
 	}
@@ -629,7 +629,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $new_txn_status
 	 */
-	public function set_new_txn_status( $new_txn_status ) {
+	public function set_new_txn_status($new_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -673,7 +673,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed( EE_Transaction $transaction ) {
+	public function all_reg_steps_completed(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -700,7 +700,7 @@ 
 	 * @param string         $exception
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except( EE_Transaction $transaction, $exception = '' ) {
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '') {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -710,7 +710,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->all_reg_steps_completed_except( $exception );
+		return $transaction->all_reg_steps_completed_except($exception);
 	}
 
 
@@ -726,7 +726,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function all_reg_steps_completed_except_final_step( EE_Transaction $transaction ) {
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -753,7 +753,7 @@ 
 	 * @param string         $reg_step_slug
 	 * @return boolean | int
 	 */
-	public function reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -763,7 +763,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->reg_step_completed( $reg_step_slug );
+		return $transaction->reg_step_completed($reg_step_slug);
 	}
 
 
@@ -779,7 +779,7 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return boolean | int
 	 */
-	public function final_reg_step_completed( EE_Transaction $transaction ) {
+	public function final_reg_step_completed(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -805,7 +805,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_initiated( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -815,7 +815,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_initiated( $reg_step_slug );
+		return $transaction->set_reg_step_initiated($reg_step_slug);
 	}
 
 
@@ -831,7 +831,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -841,7 +841,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_completed( $reg_step_slug );
+		return $transaction->set_reg_step_completed($reg_step_slug);
 	}
 
 
@@ -857,7 +857,7 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function set_reg_step_not_completed( EE_Transaction $transaction, $reg_step_slug ) {
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -867,7 +867,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		return $transaction->set_reg_step_not_completed( $reg_step_slug );
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
 	}
 
 
@@ -884,7 +884,7 @@ 
 	 * @param string          $reg_step_slug
 	 * @return void
 	 */
-	public function remove_reg_step( EE_Transaction $transaction, $reg_step_slug ) {
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -894,7 +894,7 @@ 
 			'4.9.12',
 			'5.0.0'
 		);
-		$transaction->remove_reg_step( $reg_step_slug );
+		$transaction->remove_reg_step($reg_step_slug);
 	}
 
 
@@ -910,7 +910,7 @@ 
 	 * @return    boolean
 	 * @throws \EE_Error
 	 */
-	public function toggle_failed_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_failed_transaction_status(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -934,7 +934,7 @@ 
 	 * @param  EE_Transaction $transaction
 	 * @return boolean
 	 */
-	public function toggle_abandoned_transaction_status( EE_Transaction $transaction ) {
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(