eventespresso / event-espresso-core

modules/single_page_checkout/reg_steps/attendee_information/attendee_info_main.template.php

Spacing +15 added lines, -15 removed lines

@@ -4,7 +4,7 @@ 
 /** @var string $default_hidden_inputs */
 ?>
 	<p id="spco-attendee_information-pg" class="spco-steps-pg small-text drk-grey-text">
-		<?php echo apply_filters( 'FHEE__registration_page_attendee_information__attendee_information_pg', sprintf( __('In order to process your registration, we ask you to provide the following information.%1$sPlease note that all fields marked with an asterisk (%2$s) are required.', 'event_espresso'), '<br />', '<span class="asterisk">*</span>' )); ?>
+		<?php echo apply_filters('FHEE__registration_page_attendee_information__attendee_information_pg', sprintf(__('In order to process your registration, we ask you to provide the following information.%1$sPlease note that all fields marked with an asterisk (%2$s) are required.', 'event_espresso'), '<br />', '<span class="asterisk">*</span>')); ?>
 	</p>
 
 <?php
@@ -12,34 +12,34 @@ 
 $prev_event = 0;
 $prev_ticket = 0;
 
-if ( count( $registrations ) > 0 ) {
-	foreach ( $registrations as $registration ) {
-		if ( $registration instanceof EE_Registration ) {
+if (count($registrations) > 0) {
+	foreach ($registrations as $registration) {
+		if ($registration instanceof EE_Registration) {
 			$att_nmbr++;
 ?>
 
-		<div id="spco-attendee-panel-dv-<?php echo $registration->reg_url_link();?>" class="spco-attendee-panel-dv spco-attendee-ticket-<?php echo $registration->ticket()->ID();?>">
+		<div id="spco-attendee-panel-dv-<?php echo $registration->reg_url_link(); ?>" class="spco-attendee-panel-dv spco-attendee-ticket-<?php echo $registration->ticket()->ID(); ?>">
 
-			<?php if ( $registration->event()->ID() !== $prev_event ) { ?>
+			<?php if ($registration->event()->ID() !== $prev_event) { ?>
 			<h4 id="event_title-<?php echo $registration->event()->ID() ?>" class="big-event-title-hdr">
 				<?php echo $registration->event()->name(); ?>
 			</h4>
 			<?php } ?>
-			<?php if ( $registration->ticket()->ID() !== $prev_ticket ) { ?>
-				<?php if ( ! $revisit ) { ?>
+			<?php if ($registration->ticket()->ID() !== $prev_ticket) { ?>
+				<?php if ( ! $revisit) { ?>
 			<div class="spco-ticket-info-dv small-text">
-				<h5><?php _e('Details', 'event_espresso');?></h5>
+				<h5><?php _e('Details', 'event_espresso'); ?></h5>
 				<table>
 					<thead>
 						<tr>
-							<th scope="col" width=""><?php _e('Name and Description', 'event_espresso');?></th>
-							<th scope="col" width="7.5%" class="jst-rght"><?php _e('Qty', 'event_espresso');?></th>
-							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Price', 'event_espresso');?></th>
-							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Total', 'event_espresso');?></th>
+							<th scope="col" width=""><?php _e('Name and Description', 'event_espresso'); ?></th>
+							<th scope="col" width="7.5%" class="jst-rght"><?php _e('Qty', 'event_espresso'); ?></th>
+							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Price', 'event_espresso'); ?></th>
+							<th scope="col" width="17.5%" class="jst-rght"><?php _e('Total', 'event_espresso'); ?></th>
 						</tr>
 					</thead>
 					<tbody>
-					<?php echo $ticket_line_item[ $registration->ticket()->ID() ]; ?>
+					<?php echo $ticket_line_item[$registration->ticket()->ID()]; ?>
 					</tbody>
 				</table>
 			</div>
@@ -48,7 +48,7 @@ 
 
 			<?php
 			// ATTENDEE QUESTIONS
-			$reg_form = EE_Template_Layout::get_subform_name( $registration->reg_url_link() );
+			$reg_form = EE_Template_Layout::get_subform_name($registration->reg_url_link());
 			echo ${$reg_form};
 			?>
 

modules/single_page_checkout/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Indentation +75 added lines, -75 removed lines

@@ -1,16 +1,16 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_SPCO_Reg_Step_Attendee_Information
- *
- * Description
- *
- * @package 			Event Espresso
- * @subpackage 	core
- * @author 				Brent Christensen
- * @since 				4.5.0
- *
- */
+  *
+  * Class EE_SPCO_Reg_Step_Attendee_Information
+  *
+  * Description
+  *
+  * @package 			Event Espresso
+  * @subpackage 	core
+  * @author 				Brent Christensen
+  * @since 				4.5.0
+  *
+  */
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step {
 
 	/**
@@ -135,28 +135,28 @@ 
 					$registration instanceof EE_Registration
 					&& $this->checkout->visit_allows_processing_of_this_registration( $registration )
 				) {
-                    $subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
-                    if ( ! $this->checkout->admin_request) {
-                        $template_args['registrations'][$registration->reg_url_link()] = $registration;
-                        $template_args['ticket_count'][$registration->ticket()->ID()] = isset(
-                            $template_args['ticket_count'][$registration->ticket()->ID()]
-                        )
-                            ? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
-                            : 1;
-                        $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                            $this->checkout->cart->get_grand_total(),
-                            'Ticket',
-                            array($registration->ticket()->ID())
-                        );
-                        $ticket_line_item = is_array($ticket_line_item)
-                            ? reset($ticket_line_item)
-                            : $ticket_line_item;
-                        $template_args['ticket_line_item'][$registration->ticket()->ID()] =
-                            $Line_Item_Display->display_line_item($ticket_line_item);
-                    }
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $registration->reg_url_link();
-                    }
+					$subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
+					if ( ! $this->checkout->admin_request) {
+						$template_args['registrations'][$registration->reg_url_link()] = $registration;
+						$template_args['ticket_count'][$registration->ticket()->ID()] = isset(
+							$template_args['ticket_count'][$registration->ticket()->ID()]
+						)
+							? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
+							: 1;
+						$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+							$this->checkout->cart->get_grand_total(),
+							'Ticket',
+							array($registration->ticket()->ID())
+						);
+						$ticket_line_item = is_array($ticket_line_item)
+							? reset($ticket_line_item)
+							: $ticket_line_item;
+						$template_args['ticket_line_item'][$registration->ticket()->ID()] =
+							$Line_Item_Display->display_line_item($ticket_line_item);
+					}
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $registration->reg_url_link();
+					}
 				}
 			}
 			// print_copy_info ?
@@ -168,7 +168,7 @@ 
 				// generate hidden input
 				if (
 					isset( $subsections[ $primary_registrant ] )
-				     && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+					 && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
 				) {
 					$subsections[ $primary_registrant ]->add_subsections( $copy_options, 'primary_registrant', false );
 				}
@@ -196,42 +196,42 @@ 
 
 
 
-    /**
+	/**
 	 * @param EE_Registration $registration
 	 * @return EE_Form_Section_Base
 	 * @throws \EE_Error
 	 */
 	private function _registrations_reg_form( EE_Registration $registration ) {
 		static $attendee_nmbr = 1;
-        $form_args = array();
+		$form_args = array();
 		// verify that registration has valid event
 		if ( $registration->event() instanceof EE_Event ) {
 			$question_groups = $registration->event()->question_groups(
-                array(
-                    array(
-                        'Event.EVT_ID'                     => $registration->event()->ID(),
-                        'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false
-                    ),
-                    'order_by' => array('QSG_order' => 'ASC')
-                )
-            );
+				array(
+					array(
+						'Event.EVT_ID'                     => $registration->event()->ID(),
+						'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false
+					),
+					'order_by' => array('QSG_order' => 'ASC')
+				)
+			);
 			if ( $question_groups ) {
-                // array of params to pass to parent constructor
-                $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => array(),
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        array(
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr)
-                        )
-                    )
-                );
-                foreach ( $question_groups as $question_group ) {
+				// array of params to pass to parent constructor
+				$form_args = array(
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => array(),
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						array(
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr)
+						)
+					)
+				);
+				foreach ( $question_groups as $question_group ) {
 					if ( $question_group instanceof EE_Question_Group ) {
 						$form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
 							$registration,
@@ -239,19 +239,19 @@ 
 						);
 					}
 				}
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
-                    $registration
-                );
-                // if we have question groups for additional attendees, then display the copy options
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
+					$registration
+				);
+				// if we have question groups for additional attendees, then display the copy options
 				$this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs($registration);
-                }
-            }
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs($registration);
+				}
+			}
 		}
-        $attendee_nmbr++;
+		$attendee_nmbr++;
 		return ! empty($form_args) ? new EE_Form_Section_Proper( $form_args ) : new EE_Form_Section_HTML();
 	}
 
@@ -884,7 +884,7 @@ 
 					if ( isset( $valid_data[ $reg_url_link ] ) ) {
 						// do we need to copy basic info from primary attendee ?
 						$copy_primary = isset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] )
-						                && absint( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] ) === 0
+										&& absint( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] ) === 0
 							? true
 							: false;
 						// filter form input data for this registration
@@ -1059,7 +1059,7 @@ 
 			? $form_input
 			: $form_input . '-' . $registration->reg_url_link();
 		$answer_is_obj = isset( $this->_registration_answers[ $answer_cache_id ] )
-		                 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
+						 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
 			? true
 			: false;
 		//rename form_inputs if they are EE_Attendee properties
@@ -1179,7 +1179,7 @@ 
 		// then attempt to copy them from the primary attendee
 		if (
 			$this->checkout->primary_attendee_obj instanceof EE_Attendee
-            && ! isset( $attendee_data['ATT_fname'], $attendee_data['ATT_email'] )
+			&& ! isset( $attendee_data['ATT_fname'], $attendee_data['ATT_email'] )
 		) {
 			return $this->checkout->primary_attendee_obj;
 		}
@@ -1297,7 +1297,7 @@ 
 		}
 		foreach ( $critical_attendee_details as $critical_attendee_detail ) {
 			if ( ! isset( $attendee_data[ $critical_attendee_detail ] )
-			     || empty( $attendee_data[ $critical_attendee_detail ] )
+				 || empty( $attendee_data[ $critical_attendee_detail ] )
 			) {
 				$attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
 					$critical_attendee_detail

Spacing +211 added lines, -212 removed lines

@@ -41,21 +41,21 @@ 
 	 * @access    public
 	 * @param    EE_Checkout $checkout
 	 */
-	public function __construct( EE_Checkout $checkout ) {
+	public function __construct(EE_Checkout $checkout) {
 		$this->_slug = 'attendee_information';
 		$this->_name = __('Attendee Information', 'event_espresso');
-		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+		$this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'attendee_info_main.template.php';
 		$this->checkout = $checkout;
 		$this->_reset_success_message();
 		$this->set_instructions(
-			__( 'Please answer the following registration questions before proceeding.', 'event_espresso' )
+			__('Please answer the following registration questions before proceeding.', 'event_espresso')
 		);
 	}
 
 
 
 	public function translate_js_strings() {
-		EE_Registry::$i18n_js_strings['required_field'] = __( ' is a required question.', 'event_espresso' );
+		EE_Registry::$i18n_js_strings['required_field'] = __(' is a required question.', 'event_espresso');
 		EE_Registry::$i18n_js_strings['required_multi_field'] = __(
 			' is a required question. Please enter a value for at least one of the options.',
 			'event_espresso'
@@ -115,7 +115,7 @@ 
 		// calculate taxes
 		$Line_Item_Display->display_line_item(
 			$this->checkout->cart->get_grand_total(),
-			array( 'set_tax_rate' => true )
+			array('set_tax_rate' => true)
 		);
 		/** @var $subsections EE_Form_Section_Proper[] */
 		$subsections = array(
@@ -127,13 +127,13 @@ 
 			'ticket_count' 	=> array()
 		);
 		// grab the saved registrations from the transaction
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
-		if ( $registrations ) {
-			foreach ( $registrations as $registration ) {
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
 				// can this registration be processed during this visit ?
 				if (
 					$registration instanceof EE_Registration
-					&& $this->checkout->visit_allows_processing_of_this_registration( $registration )
+					&& $this->checkout->visit_allows_processing_of_this_registration($registration)
 				) {
                     $subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
                     if ( ! $this->checkout->admin_request) {
@@ -160,17 +160,17 @@ 
 				}
 			}
 			// print_copy_info ?
-			if ( $primary_registrant && ! $this->checkout->admin_request && count( $registrations ) > 1 ) {
+			if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
 				// TODO: add admin option for toggling copy attendee info, then use that value to change $this->_print_copy_info
 				$copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
 					? $this->_copy_attendee_info_form()
 					: $this->_auto_copy_attendee_info();
 				// generate hidden input
 				if (
-					isset( $subsections[ $primary_registrant ] )
-				     && $subsections[ $primary_registrant ] instanceof EE_Form_Section_Proper
+					isset($subsections[$primary_registrant])
+				     && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
 				) {
-					$subsections[ $primary_registrant ]->add_subsections( $copy_options, 'primary_registrant', false );
+					$subsections[$primary_registrant]->add_subsections($copy_options, 'primary_registrant', false);
 				}
 			}
 
@@ -182,8 +182,7 @@ 
 				'html_id' 					=> $this->reg_form_name(),
 				'subsections' 			=> $subsections,
 				'layout_strategy'		=> $this->checkout->admin_request ?
-					new EE_Div_Per_Section_Layout() :
-					new EE_Template_Layout(
+					new EE_Div_Per_Section_Layout() : new EE_Template_Layout(
 						array(
 							'layout_template_file' 	=> $this->_template, // layout_template
 							'template_args' 				=> $template_args
@@ -201,11 +200,11 @@ 
 	 * @return EE_Form_Section_Base
 	 * @throws \EE_Error
 	 */
-	private function _registrations_reg_form( EE_Registration $registration ) {
+	private function _registrations_reg_form(EE_Registration $registration) {
 		static $attendee_nmbr = 1;
         $form_args = array();
 		// verify that registration has valid event
-		if ( $registration->event() instanceof EE_Event ) {
+		if ($registration->event() instanceof EE_Event) {
 			$question_groups = $registration->event()->question_groups(
                 array(
                     array(
@@ -215,10 +214,10 @@ 
                     'order_by' => array('QSG_order' => 'ASC')
                 )
             );
-			if ( $question_groups ) {
+			if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+                    'html_id'         => 'ee-registration-'.$registration->reg_url_link(),
                     'html_class'      => 'ee-reg-form-attendee-dv',
                     'html_style'      => $this->checkout->admin_request
                         ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
@@ -231,9 +230,9 @@ 
                         )
                     )
                 );
-                foreach ( $question_groups as $question_group ) {
-					if ( $question_group instanceof EE_Question_Group ) {
-						$form_args['subsections'][ $question_group->identifier() ] = $this->_question_group_reg_form(
+                foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
 							$registration,
 							$question_group
 						);
@@ -252,7 +251,7 @@ 
             }
 		}
         $attendee_nmbr++;
-		return ! empty($form_args) ? new EE_Form_Section_Proper( $form_args ) : new EE_Form_Section_HTML();
+		return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : new EE_Form_Section_HTML();
 	}
 
 
@@ -273,7 +272,7 @@ 
 		// generate hidden input
 		return new EE_Hidden_Input(
 			array(
-				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'html_id' => 'additional-attendee-reg-info-'.$registration->reg_url_link(),
 				'default' => $additional_attendee_reg_info
 			)
 		);
@@ -287,26 +286,26 @@ 
 	 * @return EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _question_group_reg_form( EE_Registration $registration, EE_Question_Group $question_group ){
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group) {
 		// array of params to pass to parent constructor
 		$form_args = array(
-			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+			'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier(),
 			'html_class'      => $this->checkout->admin_request
 				? 'form-table ee-reg-form-qstn-grp-dv'
 				: 'ee-reg-form-qstn-grp-dv',
-			'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
+			'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-lbl',
 			'subsections'     => array(
-				'reg_form_qstn_grp_hdr' => $this->_question_group_header( $question_group )
+				'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group)
 			),
 			'layout_strategy' => $this->checkout->admin_request
 				? new EE_Admin_Two_Column_Layout()
 				: new EE_Div_Per_Section_Layout()
 		);
 		// where params
-		$query_params = array( 'QST_deleted' => 0 );
+		$query_params = array('QST_deleted' => 0);
 		// don't load admin only questions on the frontend
-		if ( ! $this->checkout->admin_request ) {
-			$query_params['QST_admin_only'] = array( '!=', true );
+		if ( ! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = array('!=', true);
 		}
 		$questions = $question_group->get_many_related(
 			'Question',
@@ -328,10 +327,10 @@ 
 			)
 		);
 		// loop thru questions
-		foreach ( $questions as $question ) {
-			if( $question instanceof EE_Question ){
+		foreach ($questions as $question) {
+			if ($question instanceof EE_Question) {
 				$identifier = $question->is_system_question() ? $question->system_ID() : $question->ID();
-				$form_args['subsections'][ $identifier ] = $this->reg_form_question( $registration, $question );
+				$form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
 			}
 		}
 		$form_args['subsections'] = apply_filters(
@@ -352,7 +351,7 @@ 
 			)
 		);
 //		d( $form_args );
-		$question_group_reg_form = new EE_Form_Section_Proper( $form_args );
+		$question_group_reg_form = new EE_Form_Section_Proper($form_args);
 		return apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
 			$question_group_reg_form,
@@ -369,11 +368,11 @@ 
 	 * @param EE_Question_Group $question_group
 	 * @return 	EE_Form_Section_HTML
 	 */
-	private function _question_group_header( EE_Question_Group $question_group ){
+	private function _question_group_header(EE_Question_Group $question_group) {
 		$html = '';
 		// group_name
-		if ( $question_group->show_group_name() && $question_group->name() !== '' ) {
-			if ( $this->checkout->admin_request ) {
+		if ($question_group->show_group_name() && $question_group->name() !== '') {
+			if ($this->checkout->admin_request) {
 				$html .= EEH_HTML::br();
 				$html .= EEH_HTML::h3(
 					$question_group->name(),
@@ -387,7 +386,7 @@ 
 			}
 		}
 		// group_desc
-		if ( $question_group->show_group_desc() && $question_group->desc() !== '' ) {
+		if ($question_group->show_group_desc() && $question_group->desc() !== '') {
 			$html .= EEH_HTML::p(
 				$question_group->desc(),
 				'',
@@ -397,7 +396,7 @@ 
 			);
 
 		}
-		return new EE_Form_Section_HTML( $html );
+		return new EE_Form_Section_HTML($html);
 	}
 
 
@@ -407,7 +406,7 @@ 
 	 * @return    EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _copy_attendee_info_form(){
+	private function _copy_attendee_info_form() {
 		// array of params to pass to parent constructor
 		return new EE_Form_Section_Proper(
 			array(
@@ -436,7 +435,7 @@ 
 	private function _auto_copy_attendee_info() {
 		return new EE_Form_Section_HTML(
 			EEH_Template::locate_template(
-				SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+				SPCO_REG_STEPS_PATH.$this->_slug.DS.'_auto_copy_attendee_info.template.php',
 				apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
 					array()
@@ -460,32 +459,32 @@ 
 		$copy_attendee_info_inputs = array();
 		$prev_ticket = NULL;
 		// grab the saved registrations from the transaction
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
-		foreach ( $registrations as $registration ) {
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		foreach ($registrations as $registration) {
 			// for all  attendees other than the primary attendee
-			if ( $registration instanceof EE_Registration && ! $registration->is_primary_registrant() ) {
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
 				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-				if ( $registration->ticket()->ID() !== $prev_ticket ) {
+				if ($registration->ticket()->ID() !== $prev_ticket) {
 					$item_name = $registration->ticket()->name();
 					$item_name .= $registration->ticket()->description() !== ''
-						? ' - ' . $registration->ticket()->description()
+						? ' - '.$registration->ticket()->description()
 						: '';
-					$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']' ] = new EE_Form_Section_HTML(
-						'<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+					$copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'.$registration->ticket()->ID().']'] = new EE_Form_Section_HTML(
+						'<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
 					);
 					$prev_ticket = $registration->ticket()->ID();
 				}
 
-				$copy_attendee_info_inputs[ 'spco_copy_attendee_chk[' . $registration->ID() . ']' ] = new
+				$copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']'] = new
 				EE_Checkbox_Multi_Input(
 					array(
 						$registration->ID() => sprintf(
-							__( 'Attendee #%s', 'event_espresso' ),
+							__('Attendee #%s', 'event_espresso'),
 							$registration->count()
 						)
 					),
 					array(
-						'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+						'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
 						'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
 						'display_html_label_text' => false
 					)
@@ -505,7 +504,7 @@ 
 	 * @return    EE_Form_Input_Base
 	 * @throws \EE_Error
 	 */
-	private function _additional_primary_registrant_inputs( EE_Registration $registration ){
+	private function _additional_primary_registrant_inputs(EE_Registration $registration) {
 		// generate hidden input
 		return new EE_Hidden_Input(
 			array(
@@ -524,7 +523,7 @@ 
 	 * @return    EE_Form_Input_Base
 	 * @throws \EE_Error
 	 */
-	public function reg_form_question( EE_Registration $registration, EE_Question $question ){
+	public function reg_form_question(EE_Registration $registration, EE_Question $question) {
 
 		// if this question was for an attendee detail, then check for that answer
 		$answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
@@ -533,32 +532,32 @@ 
 		);
 		$answer = $answer_value === null
 			? EEM_Answer::instance()->get_one(
-				array( array( 'QST_ID' => $question->ID(), 'REG_ID' => $registration->ID() ) )
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
 			)
 			: null;
 		// if NOT returning to edit an existing registration
 		// OR if this question is for an attendee property
 		// OR we still don't have an EE_Answer object
-		if( $answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link() ) {
+		if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
 			// create an EE_Answer object for storing everything in
-			$answer = EE_Answer::new_instance ( array(
+			$answer = EE_Answer::new_instance(array(
 				'QST_ID'=> $question->ID(),
 				'REG_ID'=> $registration->ID()
 			));
 		}
 		// verify instance
-		if( $answer instanceof EE_Answer ){
-			if ( ! empty( $answer_value )) {
-				$answer->set( 'ANS_value', $answer_value );
+		if ($answer instanceof EE_Answer) {
+			if ( ! empty($answer_value)) {
+				$answer->set('ANS_value', $answer_value);
 			}
-			$answer->cache( 'Question', $question );
+			$answer->cache('Question', $question);
 			//remember system ID had a bug where sometimes it could be null
-			$answer_cache_id =$question->is_system_question()
-				? $question->system_ID() . '-' . $registration->reg_url_link()
-				: $question->ID() . '-' . $registration->reg_url_link();
-			$registration->cache( 'Answer', $answer, $answer_cache_id );
+			$answer_cache_id = $question->is_system_question()
+				? $question->system_ID().'-'.$registration->reg_url_link()
+				: $question->ID().'-'.$registration->reg_url_link();
+			$registration->cache('Answer', $answer, $answer_cache_id);
 		}
-		return $this->_generate_question_input( $registration, $question, $answer );
+		return $this->_generate_question_input($registration, $question, $answer);
 
 	}
 
@@ -571,46 +570,46 @@ 
 	 * @return EE_Form_Input_Base
 	 * @throws \EE_Error
 	 */
-	private function _generate_question_input( EE_Registration $registration, EE_Question $question, $answer ){
+	private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer) {
 		$identifier = $question->is_system_question() ? $question->system_ID() : $question->ID();
-		$this->_required_questions[ $identifier ] = $question->required() ? true : false;
+		$this->_required_questions[$identifier] = $question->required() ? true : false;
 		add_filter(
 			'FHEE__EE_Question__generate_form_input__country_options',
-			array( $this, 'use_cached_countries_for_form_input' ),
+			array($this, 'use_cached_countries_for_form_input'),
 			10,
 			4
 		);
 		add_filter(
 			'FHEE__EE_Question__generate_form_input__state_options',
-			array( $this, 'use_cached_states_for_form_input' ),
+			array($this, 'use_cached_states_for_form_input'),
 			10,
 			4
 		);
 		$input_constructor_args = array(
-			'html_name'     => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-			'html_id'       => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-			'html_class'    => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-			'html_label_id' => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_name'     => 'ee_reg_qstn['.$registration->ID().']['.$identifier.']',
+			'html_id'       => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
+			'html_class'    => 'ee-reg-qstn ee-reg-qstn-'.$identifier,
+			'html_label_id' => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
 			'html_label_class'	=> 'ee-reg-qstn',
 		);
-		$input_constructor_args['html_label_id'] 	.= '-lbl';
-		if ( $answer instanceof EE_Answer && $answer->ID() ) {
-			$input_constructor_args[ 'html_name' ] .= '[' . $answer->ID() . ']';
-			$input_constructor_args[ 'html_id' ] .= '-' . $answer->ID();
-			$input_constructor_args[ 'html_label_id' ] .= '-' . $answer->ID();
+		$input_constructor_args['html_label_id'] .= '-lbl';
+		if ($answer instanceof EE_Answer && $answer->ID()) {
+			$input_constructor_args['html_name'] .= '['.$answer->ID().']';
+			$input_constructor_args['html_id'] .= '-'.$answer->ID();
+			$input_constructor_args['html_label_id'] .= '-'.$answer->ID();
 		}
-		$form_input =  $question->generate_form_input(
+		$form_input = $question->generate_form_input(
 			$registration,
 			$answer,
 			$input_constructor_args
 		);
 		remove_filter(
 			'FHEE__EE_Question__generate_form_input__country_options',
-			array( $this, 'use_cached_countries_for_form_input' )
+			array($this, 'use_cached_countries_for_form_input')
 		);
 		remove_filter(
 			'FHEE__EE_Question__generate_form_input__state_options',
-			array( $this, 'use_cached_states_for_form_input' )
+			array($this, 'use_cached_states_for_form_input')
 		);
 		return $form_input;
 	}
@@ -632,22 +631,22 @@ 
 		\EE_Registration $registration = null,
 		\EE_Answer $answer = null
 	) {
-		$country_options = array( '' => '' );
+		$country_options = array('' => '');
 		// get possibly cached list of countries
 		$countries = $this->checkout->action === 'process_reg_step'
 			? EEM_Country::instance()->get_all_countries()
 			: EEM_Country::instance()->get_all_active_countries();
-		if ( ! empty( $countries )) {
-			foreach( $countries as $country ){
-				if ( $country instanceof EE_Country ) {
-					$country_options[ $country->ID() ] = $country->name();
+		if ( ! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[$country->ID()] = $country->name();
 				}
 			}
 		}
-		if( $question instanceof EE_Question
-			&& $registration instanceof EE_Registration ) {
+		if ($question instanceof EE_Question
+			&& $registration instanceof EE_Registration) {
 			$answer = EEM_Answer::instance()->get_one(
-				array( array( 'QST_ID' => $question->ID(), 'REG_ID' => $registration->ID() ) )
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
 			);
 		} else {
 			$answer = EE_Answer::new_instance();
@@ -680,14 +679,14 @@ 
 		\EE_Registration $registration = null,
 		\EE_Answer $answer = null
 	) {
-		$state_options = array( '' => array( '' => ''));
+		$state_options = array('' => array('' => ''));
 		$states = $this->checkout->action === 'process_reg_step'
 			? EEM_State::instance()->get_all_states()
 			: EEM_State::instance()->get_all_active_states();
-		if ( ! empty( $states )) {
-			foreach( $states as $state ){
-				if ( $state instanceof EE_State ) {
-					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+		if ( ! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[$state->country()->name()][$state->ID()] = $state->name();
 				}
 			}
 		}
@@ -715,24 +714,24 @@ 
 	 * @throws \EE_Error
 	 */
 	public function process_reg_step() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		// grab validated data from form
 		$valid_data = $this->checkout->current_step->valid_data();
 		// EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
 		// EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
 		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-		if ( empty( $valid_data ))  {
+		if (empty($valid_data)) {
 			EE_Error::add_error(
-				__( 'No valid question responses were received.', 'event_espresso' ),
+				__('No valid question responses were received.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
 			);
 			return false;
 		}
-		if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg ) {
+		if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
 			EE_Error::add_error(
-				__( 'A valid transaction could not be initiated for processing your registrations.', 'event_espresso' ),
+				__('A valid transaction could not be initiated for processing your registrations.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -740,11 +739,11 @@ 
 			return false;
 		}
 		// get cached registrations
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
 		// verify we got the goods
-		if ( empty( $registrations )) {
+		if (empty($registrations)) {
 			EE_Error::add_error(
-				__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' ),
+				__('Your form data could not be applied to any valid registrations.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -752,15 +751,15 @@ 
 			return false;
 		}
 		// extract attendee info from form data and save to model objects
-		$registrations_processed = $this->_process_registrations( $registrations, $valid_data );
+		$registrations_processed = $this->_process_registrations($registrations, $valid_data);
 		// if first pass thru SPCO,
 		// then let's check processed registrations against the total number of tickets in the cart
-		if ( $registrations_processed === false ) {
+		if ($registrations_processed === false) {
 			// but return immediately if the previous step exited early due to errors
 			return false;
-		} else if ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count ) {
+		} else if ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
 			// generate a correctly translated string for all possible singular/plural combinations
-			if ( $this->checkout->total_ticket_count === 1 && $registrations_processed !== 1 ) {
+			if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
 				$error_msg = sprintf(
 					__(
 						'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
@@ -769,7 +768,7 @@ 
 					$this->checkout->total_ticket_count,
 					$registrations_processed
 				);
-			} else if ( $this->checkout->total_ticket_count !== 1 && $registrations_processed === 1 ) {
+			} else if ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
 				$error_msg = sprintf(
 					__(
 						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
@@ -788,17 +787,17 @@ 
 					$registrations_processed
 				);
 			}
-			EE_Error::add_error( $error_msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// mark this reg step as completed
 		$this->set_completed();
 		$this->_set_success_message(
-			__( 'The Attendee Information Step has been successfully completed.', 'event_espresso' )
+			__('The Attendee Information Step has been successfully completed.', 'event_espresso')
 		);
 		//do action in case a plugin wants to do something with the data submitted in step 1.
 		//passes EE_Single_Page_Checkout, and it's posted data
-		do_action( 'AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data );
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
 		return true;
 	}
 
@@ -812,9 +811,9 @@ 
 	 * @return boolean | int
 	 * @throws \EE_Error
 	 */
-	private function _process_registrations( $registrations = array(), $valid_data = array() ) {
+	private function _process_registrations($registrations = array(), $valid_data = array()) {
 		// load resources and set some defaults
-		EE_Registry::instance()->load_model( 'Attendee' );
+		EE_Registry::instance()->load_model('Attendee');
 		// holder for primary registrant attendee object
 		$this->checkout->primary_attendee_obj = NULL;
 		// array for tracking reg form data for the primary registrant
@@ -831,9 +830,9 @@ 
 		// attendee counter
 		$att_nmbr = 0;
 		// grab the saved registrations from the transaction
-		foreach ( $registrations  as $registration ) {
+		foreach ($registrations  as $registration) {
 			// verify EE_Registration object
-			if ( ! $registration instanceof EE_Registration ) {
+			if ( ! $registration instanceof EE_Registration) {
 				EE_Error::add_error(
 					__(
 						'An invalid Registration object was discovered when attempting to process your registration information.',
@@ -848,12 +847,12 @@ 
 			/** @var string $reg_url_link */
 			$reg_url_link = $registration->reg_url_link();
 			// reg_url_link exists ?
-			if ( ! empty( $reg_url_link ) ) {
+			if ( ! empty($reg_url_link)) {
 				// should this registration be processed during this visit ?
-				if ( $this->checkout->visit_allows_processing_of_this_registration( $registration ) ) {
+				if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
 					// if NOT revisiting, then let's save the registration now,
 					// so that we have a REG_ID to use when generating other objects
-					if ( ! $this->checkout->revisit ) {
+					if ( ! $this->checkout->revisit) {
 						$registration->save();
 					}
 					/**
@@ -863,7 +862,7 @@ 
 					 * @var bool   if true is returned by the plugin then the
 					 *      		registration processing is halted.
 					 */
-					if ( apply_filters(
+					if (apply_filters(
 						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
 						false,
 						$att_nmbr,
@@ -871,38 +870,38 @@ 
 						$registrations,
 						$valid_data,
 						$this
-					) ) {
+					)) {
 						return false;
 					}
 
 					// Houston, we have a registration!
 					$att_nmbr++;
-					$this->_attendee_data[ $reg_url_link ] = array();
+					$this->_attendee_data[$reg_url_link] = array();
 					// grab any existing related answer objects
 					$this->_registration_answers = $registration->answers();
 					// unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-					if ( isset( $valid_data[ $reg_url_link ] ) ) {
+					if (isset($valid_data[$reg_url_link])) {
 						// do we need to copy basic info from primary attendee ?
-						$copy_primary = isset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] )
-						                && absint( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] ) === 0
+						$copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
+						                && absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0
 							? true
 							: false;
 						// filter form input data for this registration
-						$valid_data[ $reg_url_link ] = (array)apply_filters(
+						$valid_data[$reg_url_link] = (array) apply_filters(
 							'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-							$valid_data[ $reg_url_link ]
+							$valid_data[$reg_url_link]
 						);
 						// EEH_Debug_Tools::printr( $valid_data[ $reg_url_link ], '$valid_data[ $reg_url_link ]', __FILE__, __LINE__ );
-						if ( isset( $valid_data['primary_attendee'] )) {
-							$primary_registrant['line_item_id'] =  ! empty( $valid_data['primary_attendee'] )
+						if (isset($valid_data['primary_attendee'])) {
+							$primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
 								? $valid_data['primary_attendee']
 								: false;
-							unset( $valid_data['primary_attendee'] );
+							unset($valid_data['primary_attendee']);
 						}
 						// now loop through our array of valid post data && process attendee reg forms
-						foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs ) {
-							if ( ! in_array( $form_section, $non_input_form_sections )) {
-								foreach ( $form_inputs as $form_input => $input_value ) {
+						foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
+							if ( ! in_array($form_section, $non_input_form_sections)) {
+								foreach ($form_inputs as $form_input => $input_value) {
 									// \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
 									// check for critical inputs
 									if (
@@ -916,16 +915,16 @@ 
 									// store a bit of data about the primary attendee
 									if (
 										$att_nmbr === 1
-										&& ! empty( $input_value )
+										&& ! empty($input_value)
 										&& $reg_url_link === $primary_registrant['line_item_id']
 									) {
-										$primary_registrant[ $form_input ] = $input_value;
+										$primary_registrant[$form_input] = $input_value;
 									} else if (
 										$copy_primary
 										&& $input_value === null
-										&& isset( $primary_registrant[ $form_input ] )
+										&& isset($primary_registrant[$form_input])
 									) {
-										$input_value = $primary_registrant[ $form_input ];
+										$input_value = $primary_registrant[$form_input];
 									}
 									// now attempt to save the input data
 									if (
@@ -967,55 +966,55 @@ 
 						// have we met before?
 						$attendee = $this->_find_existing_attendee(
 							$registration,
-							$this->_attendee_data[ $reg_url_link ]
+							$this->_attendee_data[$reg_url_link]
 						);
 						// did we find an already existing record for this attendee ?
-						if ( $attendee instanceof EE_Attendee ) {
+						if ($attendee instanceof EE_Attendee) {
 							$attendee = $this->_update_existing_attendee_data(
 								$attendee,
-								$this->_attendee_data[ $reg_url_link ]
+								$this->_attendee_data[$reg_url_link]
 							);
 						} else {
 							// ensure critical details are set for additional attendees
-							$this->_attendee_data[ $reg_url_link ] = $att_nmbr > 1
+							$this->_attendee_data[$reg_url_link] = $att_nmbr > 1
 								? $this->_copy_critical_attendee_details_from_primary_registrant(
-									$this->_attendee_data[ $reg_url_link ]
+									$this->_attendee_data[$reg_url_link]
 								)
-								: $this->_attendee_data[ $reg_url_link ];
+								: $this->_attendee_data[$reg_url_link];
 							$attendee = $this->_create_new_attendee(
 								$registration,
-								$this->_attendee_data[ $reg_url_link ]
+								$this->_attendee_data[$reg_url_link]
 							);
 						}
 						// who's #1 ?
-						if ( $att_nmbr === 1 ) {
+						if ($att_nmbr === 1) {
 							$this->checkout->primary_attendee_obj = $attendee;
 						}
 					}
 					// EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
 					// add relation to registration, set attendee ID, and cache attendee
-					$this->_associate_attendee_with_registration( $registration, $attendee );
+					$this->_associate_attendee_with_registration($registration, $attendee);
 					// \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-					if ( ! $registration->attendee() instanceof EE_Attendee ) {
-						EE_Error::add_error( sprintf( __( 'Registration %s has an invalid or missing Attendee object.', 'event_espresso' ), $reg_url_link ), __FILE__, __FUNCTION__, __LINE__ );
+					if ( ! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(sprintf(__('Registration %s has an invalid or missing Attendee object.', 'event_espresso'), $reg_url_link), __FILE__, __FUNCTION__, __LINE__);
 						return 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');
 					// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
-					$registration_processor->toggle_incomplete_registration_status_to_default( $registration, false );
+					$registration_processor->toggle_incomplete_registration_status_to_default($registration, false);
 					// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
 					$this->checkout->transaction->toggle_failed_transaction_status();
 					// if we've gotten this far, then let's save what we have
 					$registration->save();
 					// add relation between TXN and registration
-					$this->_associate_registration_with_transaction( $registration );
+					$this->_associate_registration_with_transaction($registration);
 				} // end of if ( ! $this->checkout->revisit || $this->checkout->primary_revisit || ( $this->checkout->revisit && $this->checkout->reg_url_link == $reg_url_link )) {
 
-			}  else {
-				EE_Error::add_error( __( 'An invalid or missing line item ID was encountered while attempting to process the registration form.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+			} else {
+				EE_Error::add_error(__('An invalid or missing line item ID was encountered while attempting to process the registration form.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 				// remove malformed data
-				unset( $valid_data[ $reg_url_link ] );
+				unset($valid_data[$reg_url_link]);
 				return false;
 			}
 
@@ -1044,26 +1043,26 @@ 
 		// \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
 		// allow for plugins to hook in and do their own processing of the form input.
 		// For plugins to bypass normal processing here, they just need to return a boolean value.
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
 			false,
 			$registration,
 			$form_input,
 			$input_value,
 			$this
-		) ) {
+		)) {
 			return true;
 		}
 		// $answer_cache_id is the key used to find the EE_Answer we want
 		$answer_cache_id = $this->checkout->reg_url_link
 			? $form_input
-			: $form_input . '-' . $registration->reg_url_link();
-		$answer_is_obj = isset( $this->_registration_answers[ $answer_cache_id ] )
-		                 && $this->_registration_answers[ $answer_cache_id ] instanceof EE_Answer
+			: $form_input.'-'.$registration->reg_url_link();
+		$answer_is_obj = isset($this->_registration_answers[$answer_cache_id])
+		                 && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
 			? true
 			: false;
 		//rename form_inputs if they are EE_Attendee properties
-		switch( (string)$form_input ) {
+		switch ((string) $form_input) {
 
 			case 'state' :
 			case 'STA_ID' :
@@ -1078,32 +1077,32 @@ 
 				break;
 
 			default :
-				$ATT_input = 'ATT_' . $form_input;
+				$ATT_input = 'ATT_'.$form_input;
 				//EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
-				$attendee_property = EEM_Attendee::instance()->has_field( $ATT_input ) ? true : false;
-				$form_input = $attendee_property ? 'ATT_' . $form_input : $form_input;
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
+				$form_input = $attendee_property ? 'ATT_'.$form_input : $form_input;
 		}
 		// EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
 		// EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
 		// EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
 		// if this form input has a corresponding attendee property
-		if ( $attendee_property ) {
-			$this->_attendee_data[ $registration->reg_url_link() ][ $form_input ] = $input_value;
-			if ( $answer_is_obj ) {
+		if ($attendee_property) {
+			$this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
+			if ($answer_is_obj) {
 				// and delete the corresponding answer since we won't be storing this data in that object
-				$registration->_remove_relation_to( $this->_registration_answers[ $answer_cache_id ], 'Answer' );
-				$this->_registration_answers[ $answer_cache_id ]->delete_permanently();
+				$registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
+				$this->_registration_answers[$answer_cache_id]->delete_permanently();
 			}
 			return true;
-		} elseif ( $answer_is_obj ) {
+		} elseif ($answer_is_obj) {
 			// save this data to the answer object
-			$this->_registration_answers[ $answer_cache_id ]->set_value( $input_value );
-			$result = $this->_registration_answers[ $answer_cache_id ]->save();
+			$this->_registration_answers[$answer_cache_id]->set_value($input_value);
+			$result = $this->_registration_answers[$answer_cache_id]->save();
 			return $result !== false ? true : false;
 		} else {
-			foreach ( $this->_registration_answers as $answer ) {
-				if ( $answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id ) {
-					$answer->set_value( $input_value );
+			foreach ($this->_registration_answers as $answer) {
+				if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
+					$answer->set_value($input_value);
 					$result = $answer->save();
 					return $result !== false ? true : false;
 				}
@@ -1125,15 +1124,15 @@ 
 		$form_input = '',
 		$input_value = ''
 	) {
-		if ( empty( $input_value ) ) {
+		if (empty($input_value)) {
 			// if the form input isn't marked as being required, then just return
-			if ( ! isset( $this->_required_questions[ $form_input ] ) || ! $this->_required_questions[ $form_input ] ) {
+			if ( ! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
 				return true;
 			}
-			switch ( $form_input ) {
+			switch ($form_input) {
 				case 'fname' :
 					EE_Error::add_error(
-						__( 'First Name is a required value.', 'event_espresso' ),
+						__('First Name is a required value.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1142,7 +1141,7 @@ 
 					break;
 				case 'lname' :
 					EE_Error::add_error(
-						__( 'Last Name is a required value.', 'event_espresso' ),
+						__('Last Name is a required value.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1151,7 +1150,7 @@ 
 					break;
 				case 'email' :
 					EE_Error::add_error(
-						__( 'Please enter a valid email address.', 'event_espresso' ),
+						__('Please enter a valid email address.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1173,30 +1172,30 @@ 
 	 * @return boolean|EE_Attendee
 	 * @throws \EE_Error
 	 */
-	private function _find_existing_attendee( EE_Registration $registration, $attendee_data = array() ) {
+	private function _find_existing_attendee(EE_Registration $registration, $attendee_data = array()) {
 		$existing_attendee = null;
 		// if none of the critical properties are set in the incoming attendee data...
 		// then attempt to copy them from the primary attendee
 		if (
 			$this->checkout->primary_attendee_obj instanceof EE_Attendee
-            && ! isset( $attendee_data['ATT_fname'], $attendee_data['ATT_email'] )
+            && ! isset($attendee_data['ATT_fname'], $attendee_data['ATT_email'])
 		) {
 			return $this->checkout->primary_attendee_obj;
 		}
 		// does this attendee already exist in the db ?
 		// we're searching using a combination of first name, last name, AND email address
-		$ATT_fname = isset( $attendee_data['ATT_fname'] ) && ! empty( $attendee_data['ATT_fname'] )
+		$ATT_fname = isset($attendee_data['ATT_fname']) && ! empty($attendee_data['ATT_fname'])
 			? $attendee_data['ATT_fname']
 			: '';
-		$ATT_lname = isset( $attendee_data['ATT_lname'] ) && ! empty( $attendee_data['ATT_lname'] )
+		$ATT_lname = isset($attendee_data['ATT_lname']) && ! empty($attendee_data['ATT_lname'])
 			? $attendee_data['ATT_lname']
 			: '';
-		$ATT_email = isset( $attendee_data['ATT_email'] ) && ! empty( $attendee_data['ATT_email'] )
+		$ATT_email = isset($attendee_data['ATT_email']) && ! empty($attendee_data['ATT_email'])
 			? $attendee_data['ATT_email']
 			: '';
 		// but only if those have values
-		if ( $ATT_fname && $ATT_lname && $ATT_email ) {
-			$existing_attendee = EEM_Attendee::instance()->find_existing_attendee( array(
+		if ($ATT_fname && $ATT_lname && $ATT_email) {
+			$existing_attendee = EEM_Attendee::instance()->find_existing_attendee(array(
 				'ATT_fname' => $ATT_fname,
 				'ATT_lname' => $ATT_lname,
 				'ATT_email' => $ATT_email
@@ -1220,13 +1219,13 @@ 
 	 * @return \EE_Attendee
 	 * @throws \EE_Error
 	 */
-	private function _update_existing_attendee_data( EE_Attendee $existing_attendee, $attendee_data = array() ) {
+	private function _update_existing_attendee_data(EE_Attendee $existing_attendee, $attendee_data = array()) {
 		// first remove fname, lname, and email from attendee data
-		$dont_set = array( 'ATT_fname', 'ATT_lname', 'ATT_email' );
+		$dont_set = array('ATT_fname', 'ATT_lname', 'ATT_email');
 		// now loop thru what's left and add to attendee CPT
-		foreach ( $attendee_data as $property_name => $property_value ) {
-			if ( ! in_array( $property_name, $dont_set ) && EEM_Attendee::instance()->has_field( $property_name )) {
-				$existing_attendee->set( $property_name, $property_value );
+		foreach ($attendee_data as $property_name => $property_value) {
+			if ( ! in_array($property_name, $dont_set) && EEM_Attendee::instance()->has_field($property_name)) {
+				$existing_attendee->set($property_name, $property_value);
 			}
 		}
 		// better save that now
@@ -1244,11 +1243,11 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _associate_attendee_with_registration( EE_Registration $registration, EE_Attendee $attendee ) {
+	private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee) {
 		// add relation to attendee
-		$registration->_add_relation_to( $attendee, 'Attendee' );
-		$registration->set_attendee_id( $attendee->ID() );
-		$registration->update_cache_after_object_save( 'Attendee', $attendee );
+		$registration->_add_relation_to($attendee, 'Attendee');
+		$registration->set_attendee_id($attendee->ID());
+		$registration->update_cache_after_object_save('Attendee', $attendee);
 	}
 
 
@@ -1260,10 +1259,10 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	private function _associate_registration_with_transaction( EE_Registration $registration ) {
+	private function _associate_registration_with_transaction(EE_Registration $registration) {
 		// add relation to attendee
-		$this->checkout->transaction->_add_relation_to( $registration, 'Registration' );
-		$this->checkout->transaction->update_cache_after_object_save( 'Registration', $registration );
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
 	}
 
 
@@ -1276,14 +1275,14 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	private function _copy_critical_attendee_details_from_primary_registrant( $attendee_data = array() ) {
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array()) {
 		// bare minimum critical details include first name, last name, email address
-		$critical_attendee_details = array( 'ATT_fname', 'ATT_lname', 'ATT_email' );
+		$critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
 		// add address info to critical details?
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
 			false
-		) ) {
+		)) {
 			$address_details = array(
 				'ATT_address',
 				'ATT_address2',
@@ -1293,13 +1292,13 @@ 
 				'ATT_zip',
 				'ATT_phone'
 			);
-			$critical_attendee_details = array_merge( $critical_attendee_details, $address_details );
+			$critical_attendee_details = array_merge($critical_attendee_details, $address_details);
 		}
-		foreach ( $critical_attendee_details as $critical_attendee_detail ) {
-			if ( ! isset( $attendee_data[ $critical_attendee_detail ] )
-			     || empty( $attendee_data[ $critical_attendee_detail ] )
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if ( ! isset($attendee_data[$critical_attendee_detail])
+			     || empty($attendee_data[$critical_attendee_detail])
 			) {
-				$attendee_data[ $critical_attendee_detail ] = $this->checkout->primary_attendee_obj->get(
+				$attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
 					$critical_attendee_detail
 				);
 			}
@@ -1317,11 +1316,11 @@ 
 	 * @return \EE_Attendee
 	 * @throws \EE_Error
 	 */
-	private function _create_new_attendee( EE_Registration $registration, $attendee_data = array() ) {
+	private function _create_new_attendee(EE_Registration $registration, $attendee_data = array()) {
 		// create new attendee object
-		$new_attendee = EE_Attendee::new_instance( $attendee_data );
+		$new_attendee = EE_Attendee::new_instance($attendee_data);
 		// set author to event creator
-		$new_attendee->set( 'ATT_author', $registration->event()->wp_user() );
+		$new_attendee->set('ATT_author', $registration->event()->wp_user());
 		$new_attendee->save();
 		return $new_attendee;
 	}
@@ -1338,7 +1337,7 @@ 
 	 */
 	public function update_reg_step() {
 		// save everything
-		if ( $this->process_reg_step() ) {
+		if ($this->process_reg_step()) {
 			$this->checkout->redirect = true;
 			$this->checkout->redirect_url = add_query_arg(
 				array(
@@ -1347,7 +1346,7 @@ 
 				),
 				$this->checkout->thank_you_page_url
 			);
-			$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 			return true;
 		}
 		return false;

core/db_models/fields/EE_DB_Only_Field_Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param string|null   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +22 added lines, -22 removed lines

@@ -11,28 +11,28 @@
 abstract class EE_DB_Only_Field_Base extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaReadOnly(true);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaReadOnly(true);
+	}
 
 
-    /**
-     * All these children classes are for the db-only (meaning, we should select them
-     * on get_all queries, update, delete, and will still want to set their default value
-     * on inserts, but the model object won't have reference to these fields)
-     *
-     * @return boolean
-     */
-    function is_db_only_field()
-    {
-        return true;
-    }
+	/**
+	 * All these children classes are for the db-only (meaning, we should select them
+	 * on get_all queries, update, delete, and will still want to set their default value
+	 * on inserts, but the model object won't have reference to these fields)
+	 *
+	 * @return boolean
+	 */
+	function is_db_only_field()
+	{
+		return true;
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Float_Field.php

Doc Comments +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param integer|null   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {
@@ -27,7 +27,7 @@ 
      * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
      * Returns a float
      *
-     * @param type $value_inputted_for_field_on_model_object
+     * @param string $value_inputted_for_field_on_model_object
      * @return float
      */
     function prepare_for_set($value_inputted_for_field_on_model_object)

Indentation +49 added lines, -49 removed lines

@@ -8,64 +8,64 @@
 class EE_Float_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('number');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('number');
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     * Returns a float
-     *
-     * @param type $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 * Returns a float
+	 *
+	 * @param type $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
 //		echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        //remove whitespaces and thousands separators
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = str_replace(array(" ", EE_Config::instance()->currency->thsnds),
-                "", $value_inputted_for_field_on_model_object);
+		//remove whitespaces and thousands separators
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = str_replace(array(" ", EE_Config::instance()->currency->thsnds),
+				"", $value_inputted_for_field_on_model_object);
 //echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 //normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
-            $value_inputted_for_field_on_model_object = str_replace(EE_Config::instance()->currency->dec_mrk, ".",
-                $value_inputted_for_field_on_model_object);
+			$value_inputted_for_field_on_model_object = str_replace(EE_Config::instance()->currency->dec_mrk, ".",
+				$value_inputted_for_field_on_model_object);
 //echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 //double-check there's absolutely nothing left on this string besides numbers
-            $value_inputted_for_field_on_model_object = preg_replace("/[^0-9,.]/", "",
-                $value_inputted_for_field_on_model_object);
-        }
+			$value_inputted_for_field_on_model_object = preg_replace("/[^0-9,.]/", "",
+				$value_inputted_for_field_on_model_object);
+		}
 //		echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        return floatval($value_inputted_for_field_on_model_object);
-    }
+		return floatval($value_inputted_for_field_on_model_object);
+	}
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $value_on_field_to_be_outputted
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $EE = EE_Registry::instance();
-        return number_format($value_on_field_to_be_outputted, $EE->CFG->currency->dec_plc, $EE->CFG->currency->dec_mrk,
-            $EE->CFG->currency->thsnds);
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $value_on_field_to_be_outputted
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$EE = EE_Registry::instance();
+		return number_format($value_on_field_to_be_outputted, $EE->CFG->currency->dec_plc, $EE->CFG->currency->dec_mrk,
+			$EE->CFG->currency->thsnds);
+	}
 
-    function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
+	function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
 //		echo "prepare for set from db of ";d($value_found_in_db_for_model_object);
-        return floatval($value_found_in_db_for_model_object);
-    }
+		return floatval($value_found_in_db_for_model_object);
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Foreign_Key_Int_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
      * @param string  $table_column  name fo column for field
      * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
      * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+     * @param integer|null   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
      *                               dbe a string
      * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
      *                               "EEM_"

Indentation +29 added lines, -29 removed lines

@@ -4,37 +4,37 @@
 class EE_Foreign_Key_Int_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
-        $this->setSchemaType('integer');
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with __('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
+		$this->setSchemaType('integer');
+	}
 
 
-    /**
-     * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
-     * @return int
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return absint($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
+	 * @return int
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return absint($value_inputted_for_field_on_model_object);
+	}
 
-    function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return intval($value_found_in_db_for_model_object);
-    }
+	function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return intval($value_found_in_db_for_model_object);
+	}
 
 }
\ No newline at end of file

core/db_models/fields/EE_Full_HTML_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param string   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +48 added lines, -48 removed lines

@@ -15,57 +15,57 @@
 class EE_Full_HTML_Field extends EE_Text_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
 
-    /**
-     * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
-     *
-     * @param type $value_on_field_to_be_outputted
-     * @param type $schema
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema == 'form_input') {
-            return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-        } elseif ($schema == 'no_wpautop') {
-            return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
-        } else {
-            return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
-        }
-    }
+	/**
+	 * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
+	 *
+	 * @param type $value_on_field_to_be_outputted
+	 * @param type $schema
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema == 'form_input') {
+			return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+		} elseif ($schema == 'no_wpautop') {
+			return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
+		} else {
+			return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
+		}
+	}
 
 
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    __('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string'
-            ),
-            'rendered' => array(
-                'description' =>  sprintf(
-                    __('%s - transformed for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string',
-                'readonly' => true
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string'
+			),
+			'rendered' => array(
+				'description' =>  sprintf(
+					__('%s - transformed for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string',
+				'readonly' => true
+			)
+		);
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Integer_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param integer|null   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +19 added lines, -19 removed lines

@@ -7,26 +7,26 @@
  */
 class EE_Integer_Field extends EE_Model_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('integer');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('integer');
+	}
 
 
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return intval($value_inputted_for_field_on_model_object);
-    }
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return intval($value_inputted_for_field_on_model_object);
+	}
 
-    function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        return intval($value_inputted_for_field_on_model_object);
-    }
+	function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		return intval($value_inputted_for_field_on_model_object);
+	}
 }

core/db_models/fields/EE_Model_Field_Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -582,7 +582,7 @@
     /**
      * Validates that the incoming format is an allowable string to use for the _schema_format property
      * @throws InvalidArgumentException
-     * @param $format
+     * @param string $format
      */
     private function validateSchemaFormat($format)
     {

Indentation +597 added lines, -598 removed lines

@@ -21,602 +21,601 @@
  */
 abstract class EE_Model_Field_Base implements HasSchemaInterface
 {
-    /**
-     * The alias for the table the column belongs to.
-     * @var string
-     */
-    protected $_table_alias;
-
-    /**
-     * The actual db column name for the table
-     * @var string
-     */
-    protected $_table_column;
-
-
-    /**
-     * The authoritative name for the table column (used by client code to reference the field).
-     * @var string
-     */
-    protected $_name;
-
-
-    /**
-     * A description for the field.
-     * @var string
-     */
-    protected $_nicename;
-
-
-    /**
-     * Whether the field is nullable or not
-     * @var bool
-     */
-    protected $_nullable;
-
-
-    /**
-     * What the default value for the field should be.
-     * @var mixed
-     */
-    protected $_default_value;
-
-
-    /**
-     * Other configuration for the field
-     * @var mixed
-     */
-    protected $_other_config;
-
-
-    /**
-     * The name of the model this field is instantiated for.
-     * @var string
-     */
-    protected $_model_name;
-
-
-    /**
-     * This should be a json-schema valid data type for the field.
-     * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-     * @var string
-     */
-    private $_schema_type = 'string';
-
-
-    /**
-     * If the schema has a defined format then it should be defined via this property.
-     * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-     * @var string
-     */
-    private $_schema_format = '';
-
-
-    /**
-     * Indicates that the value of the field is managed exclusively by the server/model and not something
-     * settable by client code.
-     * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
-     * @var bool
-     */
-    private $_schema_readonly = false;
-
-
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        $this->_table_column  = $table_column;
-        $this->_nicename      = $nicename;
-        $this->_nullable      = $nullable;
-        $this->_default_value = $default_value;
-    }
-
-
-    /**
-     * @param $table_alias
-     * @param $name
-     * @param $model_name
-     */
-    public function _construct_finalize($table_alias, $name, $model_name)
-    {
-        $this->_table_alias = $table_alias;
-        $this->_name        = $name;
-        $this->_model_name  = $model_name;
-        /**
-         * allow for changing the defaults
-         */
-        $this->_nicename      = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___nicename',
-            $this->_nicename, $this);
-        $this->_default_value = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___default_value',
-            $this->_default_value, $this);
-    }
-
-    public function get_table_alias()
-    {
-        return $this->_table_alias;
-    }
-
-    public function get_table_column()
-    {
-        return $this->_table_column;
-    }
-
-    /**
-     * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
-     *
-     * @return string
-     */
-    public function get_model_name()
-    {
-        return $this->_model_name;
-    }
-
-    /**
-     * @throws \EE_Error
-     * @return string
-     */
-    public function get_name()
-    {
-        if ($this->_name) {
-            return $this->_name;
-        } else {
-            throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
-                "event_espresso"), get_class($this)));
-        }
-    }
-
-    public function get_nicename()
-    {
-        return $this->_nicename;
-    }
-
-    public function is_nullable()
-    {
-        return $this->_nullable;
-    }
-
-    /**
-     * returns whether this field is an auto-increment field or not. If it is, then
-     * on insertion it can be null. However, on updates it must be present.
-     *
-     * @return boolean
-     */
-    public function is_auto_increment()
-    {
-        return false;
-    }
-
-    /**
-     * The default value in the model object's value domain. See lengthy comment about
-     * value domains at the top of EEM_Base
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        return $this->_default_value;
-    }
-
-    /**
-     * Returns the table alias joined to the table column, however this isn't the right
-     * table alias if the aliased table is being joined to. In that case, you can use
-     * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
-     * in the current query
-     *
-     * @return string
-     */
-    public function get_qualified_column()
-    {
-        return $this->get_table_alias() . "." . $this->get_table_column();
-    }
-
-    /**
-     * When get() is called on a model object (eg EE_Event), before returning its value,
-     * call this function on it, allowing us to customize the returned value based on
-     * the field's type. Eg, we may want ot serialize it, strip tags, etc. By default,
-     * we simply return it.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. We may want to add slashes, serialize it, etc.
-     * By default, we do nothing.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $value_of_field_on_model_object;
-    }
-
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return mixed
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $value_inputted_for_field_on_model_object;
-    }
-
-
-    /**
-     * When instantiating a model object from DB results, this function is called before setting each field.
-     * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
-     * is the one child classes will most often define.
-     *
-     * @param mixed $value_found_in_db_for_model_object
-     * @return mixed
-     */
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return $this->prepare_for_set($value_found_in_db_for_model_object);
-    }
-
-    /**
-     * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
-     * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
-     * 2013, at 3:23pm" instead of
-     * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
-     *
-     * @param mixed $value_on_field_to_be_outputted
-     * @return mixed
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return $value_on_field_to_be_outputted;
-    }
-
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     * @return string
-     */
-    public function getSchemaDescription()
-    {
-        return $this->get_nicename();
-    }
-
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     * @return string|array
-     */
-    public function getSchemaType()
-    {
-        if ($this->is_nullable()) {
-            $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
-                $this->_schema_type[] = 'null';
-            };
-        }
-        return $this->_schema_type;
-    }
-
-
-    /**
-     * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
-     * for this property.
-     * @param string|array $type
-     * @throws InvalidArgumentException
-     */
-    protected function setSchemaType($type)
-    {
-        $this->validateSchemaType($type);
-        $this->_schema_type = $type;
-    }
-
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     *
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties()
-    {
-        return array();
-    }
-
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum()
-    {
-        return array();
-    }
-
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     * @return string
-     */
-    public function getSchemaFormat()
-    {
-        return $this->_schema_format;
-    }
-
-
-    /**
-     * Sets the schema format property.
-     * @throws InvalidArgumentException
-     * @param string $format
-     */
-    protected function setSchemaFormat($format)
-    {
-        $this->validateSchemaFormat($format);
-        $this->_schema_format = $format;
-    }
-
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     * @return bool
-     */
-    public function getSchemaReadonly()
-    {
-        return $this->_schema_readonly;
-    }
-
-
-    /**
-     * This sets the value for the $_schema_readonly property.
-     * @param bool $readonly  (only explicit boolean values are accepted)
-     */
-    protected function setSchemaReadOnly($readonly)
-    {
-        if (! is_bool($readonly)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
-                    print_r($readonly, true)
-                )
-            );
-        }
-
-        $this->_schema_readonly = $readonly;
-    }
-
-
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field.
-     * @uses _get_wpdb_data_type()
-     *
-     * @return string
-     */
-    public function get_wpdb_data_type()
-    {
-        return $this->_get_wpdb_data_type();
-    }
-
-
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
-     * @param string $type  Included if a specific type is requested.
-     * @uses get_schema_type()
-     * @return string
-     */
-    protected function _get_wpdb_data_type($type='')
-    {
-        $type = empty($type) ? $this->getSchemaType() : $type;
-
-        //if type is an array, then different parsing is required.
-        if (is_array($type)) {
-            return $this->_get_wpdb_data_type_for_type_array($type);
-        }
-
-        $wpdb_type = '%s';
-        switch ($type) {
-            case 'number':
-                $wpdb_type = '%f';
-                break;
-            case 'integer':
-            case 'boolean':
-                $wpdb_type = '%d';
-                break;
-            case 'object':
-                $properties = $this->getSchemaProperties();
-                if (isset($properties['raw'], $properties['raw']['type'])) {
-                    $wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
-                }
-                break; //leave at default
-        }
-        return $wpdb_type;
-    }
-
-
-
-    protected function _get_wpdb_data_type_for_type_array($type)
-    {
-        $type = (array) $type;
-        //first let's flip because then we can do a faster key check
-        $type = array_flip($type);
-
-        //check for things that mean '%s'
-        if (isset($type['string'],$type['object'],$type['array'])) {
-            return '%s';
-        }
-
-        //if makes it past the above condition and there's float in the array
-        //then the type is %f
-        if (isset($type['number'])) {
-            return '%f';
-        }
-
-        //if it makes it above the above conditions and there is an integer in the array
-        //then the type is %d
-        if (isset($type['integer'])) {
-            return '%d';
-        }
-
-        //anything else is a string
-        return '%s';
-    }
-
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema()
-    {
-        $schema = array(
-            'description' => $this->getSchemaDescription(),
-            'type' => $this->getSchemaType(),
-            'readonly' => $this->getSchemaReadonly(),
-        );
-
-        //optional properties of the schema
-        $enum = $this->getSchemaEnum();
-        $properties = $this->getSchemaProperties();
-        $format = $this->getSchemaFormat();
-        if ($enum) {
-            $schema['enum'] = $enum;
-        }
-
-        if ($properties) {
-            $schema['properties'] = $properties;
-        }
-
-        if ($format) {
-            $schema['format'] = $format;
-        }
-        return $schema;
-    }
-
-    /**
-     * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
-     * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
-     * want to see their value, then they shouldn't be db-only fields!)
-     * Eg, when doing events as custom post types, querying the post_type is essential, but
-     * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
-     * By default, all fields aren't db-only.
-     *
-     * @return boolean
-     */
-    public function is_db_only_field()
-    {
-        return false;
-    }
-
-
-    /**
-     * Validates the incoming string|array to ensure its an allowable type.
-     * @throws InvalidArgumentException
-     * @param string|array $type
-     */
-    private function validateSchemaType($type)
-    {
-        if (! (is_string($type) || is_array($type))) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
-                    print_r($type, true)
-                )
-            );
-        }
-
-        //validate allowable types.
-        //@link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
-        $allowable_types = array_flip(
-            array(
-                'string',
-                'number',
-                'null',
-                'object',
-                'array',
-                'boolean',
-                'integer'
-            )
-        );
-
-        if (is_array($type)) {
-            foreach ($type as $item_in_type) {
-                $this->validateSchemaType($item_in_type);
-            }
-            return;
-        }
-
-        if (! isset($allowable_types[$type])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
-                    $type,
-                    implode(',', array_flip($allowable_types))
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Validates that the incoming format is an allowable string to use for the _schema_format property
-     * @throws InvalidArgumentException
-     * @param $format
-     */
-    private function validateSchemaFormat($format)
-    {
-        if (! is_string($format)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
-                    print_r($format, true)
-                )
-            );
-        }
-
-        //validate allowable format values
-        //@link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
-        $allowable_formats = array_flip(
-            array(
-                'date-time',
-                'email',
-                'hostname',
-                'ipv4',
-                'ipv6',
-                'uri',
-                'uriref'
-            )
-        );
-
-        if (! isset($allowable_formats[$format])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),
-                    $format,
-                    implode(',', array_flip($allowable_formats))
-                )
-            );
-        }
-    }
+	/**
+	 * The alias for the table the column belongs to.
+	 * @var string
+	 */
+	protected $_table_alias;
+
+	/**
+	 * The actual db column name for the table
+	 * @var string
+	 */
+	protected $_table_column;
+
+
+	/**
+	 * The authoritative name for the table column (used by client code to reference the field).
+	 * @var string
+	 */
+	protected $_name;
+
+
+	/**
+	 * A description for the field.
+	 * @var string
+	 */
+	protected $_nicename;
+
+
+	/**
+	 * Whether the field is nullable or not
+	 * @var bool
+	 */
+	protected $_nullable;
+
+
+	/**
+	 * What the default value for the field should be.
+	 * @var mixed
+	 */
+	protected $_default_value;
+
+
+	/**
+	 * Other configuration for the field
+	 * @var mixed
+	 */
+	protected $_other_config;
+
+
+	/**
+	 * The name of the model this field is instantiated for.
+	 * @var string
+	 */
+	protected $_model_name;
+
+
+	/**
+	 * This should be a json-schema valid data type for the field.
+	 * @link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+	 * @var string
+	 */
+	private $_schema_type = 'string';
+
+
+	/**
+	 * If the schema has a defined format then it should be defined via this property.
+	 * @link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+	 * @var string
+	 */
+	private $_schema_format = '';
+
+
+	/**
+	 * Indicates that the value of the field is managed exclusively by the server/model and not something
+	 * settable by client code.
+	 * @link http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.4.4
+	 * @var bool
+	 */
+	private $_schema_readonly = false;
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		$this->_table_column  = $table_column;
+		$this->_nicename      = $nicename;
+		$this->_nullable      = $nullable;
+		$this->_default_value = $default_value;
+	}
+
+
+	/**
+	 * @param $table_alias
+	 * @param $name
+	 * @param $model_name
+	 */
+	public function _construct_finalize($table_alias, $name, $model_name)
+	{
+		$this->_table_alias = $table_alias;
+		$this->_name        = $name;
+		$this->_model_name  = $model_name;
+		/**
+		 * allow for changing the defaults
+		 */
+		$this->_nicename      = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___nicename',
+			$this->_nicename, $this);
+		$this->_default_value = apply_filters('FHEE__EE_Model_Field_Base___construct_finalize___default_value',
+			$this->_default_value, $this);
+	}
+
+	public function get_table_alias()
+	{
+		return $this->_table_alias;
+	}
+
+	public function get_table_column()
+	{
+		return $this->_table_column;
+	}
+
+	/**
+	 * Returns the name of the model this field is on. Eg 'Event' or 'Ticket_Datetime'
+	 *
+	 * @return string
+	 */
+	public function get_model_name()
+	{
+		return $this->_model_name;
+	}
+
+	/**
+	 * @throws \EE_Error
+	 * @return string
+	 */
+	public function get_name()
+	{
+		if ($this->_name) {
+			return $this->_name;
+		} else {
+			throw new EE_Error(sprintf(__("Model field '%s' has no name set. Did you make a model and forget to call the parent model constructor?",
+				"event_espresso"), get_class($this)));
+		}
+	}
+
+	public function get_nicename()
+	{
+		return $this->_nicename;
+	}
+
+	public function is_nullable()
+	{
+		return $this->_nullable;
+	}
+
+	/**
+	 * returns whether this field is an auto-increment field or not. If it is, then
+	 * on insertion it can be null. However, on updates it must be present.
+	 *
+	 * @return boolean
+	 */
+	public function is_auto_increment()
+	{
+		return false;
+	}
+
+	/**
+	 * The default value in the model object's value domain. See lengthy comment about
+	 * value domains at the top of EEM_Base
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		return $this->_default_value;
+	}
+
+	/**
+	 * Returns the table alias joined to the table column, however this isn't the right
+	 * table alias if the aliased table is being joined to. In that case, you can use
+	 * EE_Model_Parser::extract_table_alias_model_relation_chain_prefix() to find the table's current alias
+	 * in the current query
+	 *
+	 * @return string
+	 */
+	public function get_qualified_column()
+	{
+		return $this->get_table_alias() . "." . $this->get_table_column();
+	}
+
+	/**
+	 * When get() is called on a model object (eg EE_Event), before returning its value,
+	 * call this function on it, allowing us to customize the returned value based on
+	 * the field's type. Eg, we may want ot serialize it, strip tags, etc. By default,
+	 * we simply return it.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. We may want to add slashes, serialize it, etc.
+	 * By default, we do nothing.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $value_of_field_on_model_object;
+	}
+
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $value_inputted_for_field_on_model_object;
+	}
+
+
+	/**
+	 * When instantiating a model object from DB results, this function is called before setting each field.
+	 * We may want to serialize the value, etc. By default, we return the value using prepare_for_set() method as that
+	 * is the one child classes will most often define.
+	 *
+	 * @param mixed $value_found_in_db_for_model_object
+	 * @return mixed
+	 */
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return $this->prepare_for_set($value_found_in_db_for_model_object);
+	}
+
+	/**
+	 * When echoing a field's value on a model object, this function is run to prepare the value for presentation in a
+	 * webpage. For example, we may want to output floats with 2 decimal places by default, dates as "Monday Jan 12,
+	 * 2013, at 3:23pm" instead of
+	 * "8765678632", or any other modifications to how the value should be displayed, but not modified itself.
+	 *
+	 * @param mixed $value_on_field_to_be_outputted
+	 * @return mixed
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return $value_on_field_to_be_outputted;
+	}
+
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 * @return string
+	 */
+	public function getSchemaDescription()
+	{
+		return $this->get_nicename();
+	}
+
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 * @return string|array
+	 */
+	public function getSchemaType()
+	{
+		if ($this->is_nullable()) {
+			$this->_schema_type = (array) $this->_schema_type;
+			if (! in_array('null', $this->_schema_type)) {
+				$this->_schema_type[] = 'null';
+			};
+		}
+		return $this->_schema_type;
+	}
+
+
+	/**
+	 * Sets the _schema_type property.  Child classes should call this in their constructors to override the default state
+	 * for this property.
+	 * @param string|array $type
+	 * @throws InvalidArgumentException
+	 */
+	protected function setSchemaType($type)
+	{
+		$this->validateSchemaType($type);
+		$this->_schema_type = $type;
+	}
+
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 *
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties()
+	{
+		return array();
+	}
+
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum()
+	{
+		return array();
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 * @return string
+	 */
+	public function getSchemaFormat()
+	{
+		return $this->_schema_format;
+	}
+
+
+	/**
+	 * Sets the schema format property.
+	 * @throws InvalidArgumentException
+	 * @param string $format
+	 */
+	protected function setSchemaFormat($format)
+	{
+		$this->validateSchemaFormat($format);
+		$this->_schema_format = $format;
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 * @return bool
+	 */
+	public function getSchemaReadonly()
+	{
+		return $this->_schema_readonly;
+	}
+
+
+	/**
+	 * This sets the value for the $_schema_readonly property.
+	 * @param bool $readonly  (only explicit boolean values are accepted)
+	 */
+	protected function setSchemaReadOnly($readonly)
+	{
+		if (! is_bool($readonly)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
+					print_r($readonly, true)
+				)
+			);
+		}
+
+		$this->_schema_readonly = $readonly;
+	}
+
+
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field.
+	 * @uses _get_wpdb_data_type()
+	 *
+	 * @return string
+	 */
+	public function get_wpdb_data_type()
+	{
+		return $this->_get_wpdb_data_type();
+	}
+
+
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
+	 * @param string $type  Included if a specific type is requested.
+	 * @uses get_schema_type()
+	 * @return string
+	 */
+	protected function _get_wpdb_data_type($type='')
+	{
+		$type = empty($type) ? $this->getSchemaType() : $type;
+
+		//if type is an array, then different parsing is required.
+		if (is_array($type)) {
+			return $this->_get_wpdb_data_type_for_type_array($type);
+		}
+
+		$wpdb_type = '%s';
+		switch ($type) {
+			case 'number':
+				$wpdb_type = '%f';
+				break;
+			case 'integer':
+			case 'boolean':
+				$wpdb_type = '%d';
+				break;
+			case 'object':
+				$properties = $this->getSchemaProperties();
+				if (isset($properties['raw'], $properties['raw']['type'])) {
+					$wpdb_type = $this->_get_wpdb_data_type($properties['raw']['type']);
+				}
+				break; //leave at default
+		}
+		return $wpdb_type;
+	}
+
+
+
+	protected function _get_wpdb_data_type_for_type_array($type)
+	{
+		$type = (array) $type;
+		//first let's flip because then we can do a faster key check
+		$type = array_flip($type);
+
+		//check for things that mean '%s'
+		if (isset($type['string'],$type['object'],$type['array'])) {
+			return '%s';
+		}
+
+		//if makes it past the above condition and there's float in the array
+		//then the type is %f
+		if (isset($type['number'])) {
+			return '%f';
+		}
+
+		//if it makes it above the above conditions and there is an integer in the array
+		//then the type is %d
+		if (isset($type['integer'])) {
+			return '%d';
+		}
+
+		//anything else is a string
+		return '%s';
+	}
+
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema()
+	{
+		$schema = array(
+			'description' => $this->getSchemaDescription(),
+			'type' => $this->getSchemaType(),
+			'readonly' => $this->getSchemaReadonly(),
+		);
+
+		//optional properties of the schema
+		$enum = $this->getSchemaEnum();
+		$properties = $this->getSchemaProperties();
+		$format = $this->getSchemaFormat();
+		if ($enum) {
+			$schema['enum'] = $enum;
+		}
+
+		if ($properties) {
+			$schema['properties'] = $properties;
+		}
+
+		if ($format) {
+			$schema['format'] = $format;
+		}
+		return $schema;
+	}
+
+	/**
+	 * Some fields are in the database-only, (ie, used in queries etc), but shouldn't necessarily be part
+	 * of the model objects (ie, client code shouldn't care to ever see their value... if client code does
+	 * want to see their value, then they shouldn't be db-only fields!)
+	 * Eg, when doing events as custom post types, querying the post_type is essential, but
+	 * post_type is irrelevant for EE_Event objects (because they will ALL be of post_type 'esp_event').
+	 * By default, all fields aren't db-only.
+	 *
+	 * @return boolean
+	 */
+	public function is_db_only_field()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Validates the incoming string|array to ensure its an allowable type.
+	 * @throws InvalidArgumentException
+	 * @param string|array $type
+	 */
+	private function validateSchemaType($type)
+	{
+		if (! (is_string($type) || is_array($type))) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
+					print_r($type, true)
+				)
+			);
+		}
+
+		//validate allowable types.
+		//@link http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
+		$allowable_types = array_flip(
+			array(
+				'string',
+				'number',
+				'null',
+				'object',
+				'array',
+				'boolean',
+				'integer'
+			)
+		);
+
+		if (is_array($type)) {
+			foreach ($type as $item_in_type) {
+				$this->validateSchemaType($item_in_type);
+			}
+			return;
+		}
+
+		if (! isset($allowable_types[$type])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
+					$type,
+					implode(',', array_flip($allowable_types))
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Validates that the incoming format is an allowable string to use for the _schema_format property
+	 * @throws InvalidArgumentException
+	 * @param $format
+	 */
+	private function validateSchemaFormat($format)
+	{
+		if (! is_string($format)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
+					print_r($format, true)
+				)
+			);
+		}
+
+		//validate allowable format values
+		//@link http://json-schema.org/latest/json-schema-validation.html#rfc.section.7
+		$allowable_formats = array_flip(
+			array(
+				'date-time',
+				'email',
+				'hostname',
+				'ipv4',
+				'ipv6',
+				'uri',
+				'uriref'
+			)
+		);
+
+		if (! isset($allowable_formats[$format])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),
+					$format,
+					implode(',', array_flip($allowable_formats))
+				)
+			);
+		}
+	}
 }
\ No newline at end of file

Spacing +9 added lines, -9 removed lines

@@ -211,7 +211,7 @@ 
      */
     public function get_qualified_column()
     {
-        return $this->get_table_alias() . "." . $this->get_table_column();
+        return $this->get_table_alias().".".$this->get_table_column();
     }
 
     /**
@@ -302,7 +302,7 @@ 
     {
         if ($this->is_nullable()) {
             $this->_schema_type = (array) $this->_schema_type;
-            if (! in_array('null', $this->_schema_type)) {
+            if ( ! in_array('null', $this->_schema_type)) {
                 $this->_schema_type[] = 'null';
             };
         }
@@ -391,7 +391,7 @@ 
      */
     protected function setSchemaReadOnly($readonly)
     {
-        if (! is_bool($readonly)) {
+        if ( ! is_bool($readonly)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a boolean.', 'event_espresso'),
@@ -424,7 +424,7 @@ 
      * @uses get_schema_type()
      * @return string
      */
-    protected function _get_wpdb_data_type($type='')
+    protected function _get_wpdb_data_type($type = '')
     {
         $type = empty($type) ? $this->getSchemaType() : $type;
 
@@ -461,7 +461,7 @@ 
         $type = array_flip($type);
 
         //check for things that mean '%s'
-        if (isset($type['string'],$type['object'],$type['array'])) {
+        if (isset($type['string'], $type['object'], $type['array'])) {
             return '%s';
         }
 
@@ -537,7 +537,7 @@ 
      */
     private function validateSchemaType($type)
     {
-        if (! (is_string($type) || is_array($type))) {
+        if ( ! (is_string($type) || is_array($type))) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a string or an array.', 'event_espresso'),
@@ -567,7 +567,7 @@ 
             return;
         }
 
-        if (! isset($allowable_types[$type])) {
+        if ( ! isset($allowable_types[$type])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%1$s) must be one of the allowable types: %2$s', 'event_espresso'),
@@ -586,7 +586,7 @@ 
      */
     private function validateSchemaFormat($format)
     {
-        if (! is_string($format)) {
+        if ( ! is_string($format)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%s) must be a string.', 'event_espresso'),
@@ -609,7 +609,7 @@ 
             )
         );
 
-        if (! isset($allowable_formats[$format])) {
+        if ( ! isset($allowable_formats[$format])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__('The incoming argument (%1$s) must be one of the allowable formats: %2$s', 'event_espresso'),

core/db_models/fields/EE_Money_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param integer   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +77 added lines, -77 removed lines

@@ -8,91 +8,91 @@
 class EE_Money_Field extends EE_Float_Field
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('object');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('object');
+	}
 
 
-    /**
-     * Schemas:
-     *    'localized_float': "3,023.00"
-     *    'no_currency_code': "$3,023.00"
-     *    null: "$3,023.00<span>USD</span>"
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	/**
+	 * Schemas:
+	 *    'localized_float': "3,023.00"
+	 *    'no_currency_code': "$3,023.00"
+	 *    null: "$3,023.00<span>USD</span>"
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$pretty_float = parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
 
-        if ($schema == 'localized_float') {
-            return $pretty_float;
-        }
-        if ($schema == 'no_currency_code') {
+		if ($schema == 'localized_float') {
+			return $pretty_float;
+		}
+		if ($schema == 'no_currency_code') {
 //			echo "schema no currency!";
-            $display_code = false;
-        } else {
-            $display_code = true;
-        }
-        //we don't use the $pretty_float because format_currency will take care of it.
-        return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
-    }
+			$display_code = false;
+		} else {
+			$display_code = true;
+		}
+		//we don't use the $pretty_float because format_currency will take care of it.
+		return EEH_Template::format_currency($value_on_field_to_be_outputted, false, $display_code);
+	}
 
-    /**
-     * If provided with a string, strips out money-related formatting to turn it into a proper float.
-     * Rounds the float to the correct number of decimal places for this country's currency.
-     * Also, interprets periods and commas according to the country's currency settings.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        //remove any currencies etc.
+	/**
+	 * If provided with a string, strips out money-related formatting to turn it into a proper float.
+	 * Rounds the float to the correct number of decimal places for this country's currency.
+	 * Also, interprets periods and commas according to the country's currency settings.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		//remove any currencies etc.
 //		if(is_string($value_inputted_for_field_on_model_object)){
 //			$value_inputted_for_field_on_model_object = preg_replace("/[^0-9,.]/", "", $value_inputted_for_field_on_model_object);
 //		}
-        //now it's a float-style string or number
-        $float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
-        //round to the correctly number of decimal places for this  currency
-        $rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
-        return $rounded_value;
-    }
+		//now it's a float-style string or number
+		$float_val = parent::prepare_for_set($value_inputted_for_field_on_model_object);
+		//round to the correctly number of decimal places for this  currency
+		$rounded_value = round($float_val, EE_Registry::instance()->CFG->currency->dec_plc);
+		return $rounded_value;
+	}
 
-    function prepare_for_get($value_of_field_on_model_object)
-    {
-        $c = EE_Registry::instance()->CFG->currency;
-        return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
-    }
+	function prepare_for_get($value_of_field_on_model_object)
+	{
+		$c = EE_Registry::instance()->CFG->currency;
+		return round(parent::prepare_for_get($value_of_field_on_model_object), $c->dec_plc);
+	}
 
-    public function getSchemaProperties()
-    {
-        return array(
-            'raw' => array(
-                'description' =>  sprintf(
-                    __('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'number'
-            ),
-            'pretty' => array(
-                'description' =>  sprintf(
-                    __('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type' => 'string'
-            )
-        );
-    }
+	public function getSchemaProperties()
+	{
+		return array(
+			'raw' => array(
+				'description' =>  sprintf(
+					__('%s - the raw value as it exists in the database as a simple float.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'number'
+			),
+			'pretty' => array(
+				'description' =>  sprintf(
+					__('%s - formatted for display in the set currency and decimal places.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type' => 'string'
+			)
+		);
+	}
 }
\ No newline at end of file