eventespresso / event-espresso-core

core/domain/entities/GenericAddress.php

Doc Comments +4 added lines, -2 removed lines

@@ -37,6 +37,8 @@ 
      * @param \EE_State | string   $state
      * @param string               $zip
      * @param \EE_Country | string $country
+     * @param integer $state
+     * @param string $country
      * @return GenericAddress
      */
     public function __construct($address, $address2, $city, $state, $zip, $country)
@@ -130,7 +132,7 @@ 
 
 
     /**
-     * @return \EE_State
+     * @return string
      */
     public function state_obj()
     {
@@ -183,7 +185,7 @@ 
 
 
     /**
-     * @return \EE_Country
+     * @return string
      */
     public function country_obj()
     {

Indentation +201 added lines, -201 removed lines

@@ -12,205 +12,205 @@
  */
 class GenericAddress implements \EEI_Address
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    private $_address = '';
-
-    private $_address2 = '';
-
-    private $_city = '';
-
-    private $_state_ID = '';
-
-    private $_state_obj = '';
-
-    private $_zip = '';
-
-    private $_country_ID = '';
-
-    private $_country_obj = '';
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * @param string               $address
-     * @param string               $address2
-     * @param string               $city
-     * @param \EE_State | string   $state
-     * @param string               $zip
-     * @param \EE_Country | string $country
-     * @return GenericAddress
-     */
-    public function __construct($address, $address2, $city, $state, $zip, $country)
-    {
-        $this->_address = $address;
-        $this->_address2 = $address2;
-        $this->_city = $city;
-        if ($state instanceof \EE_State) {
-            $this->_state_obj = $state;
-        } else {
-            $this->_state_ID = $state;
-            $this->_state_obj = $this->_get_state_obj();
-        }
-        $this->_zip = $zip;
-        if ($country instanceof \EE_Country) {
-            $this->_country_obj = $country;
-        } else {
-            $this->_country_ID = $country;
-            $this->_country_obj = $this->_get_country_obj();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address()
-    {
-        return $this->_address;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->_address2;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function city()
-    {
-        return $this->_city;
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * @return \EE_State
-     */
-    private function _get_state_obj()
-    {
-        return $this->_state_obj instanceof \EE_State
-            ? $this->_state_obj
-            : \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_ID()
-    {
-        return $this->_state_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->abbrev()
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_State
-     */
-    public function state_obj()
-    {
-        return $this->_state_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_obj()->abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    private function _get_country_obj()
-    {
-        return $this->_country_obj instanceof \EE_Country
-            ? $this->_country_obj
-            : \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->_country_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name()
-    {
-        return $this->country_obj() instanceof \EE_Country
-            ? $this->country_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->_country_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->_zip;
-    }
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	private $_address = '';
+
+	private $_address2 = '';
+
+	private $_city = '';
+
+	private $_state_ID = '';
+
+	private $_state_obj = '';
+
+	private $_zip = '';
+
+	private $_country_ID = '';
+
+	private $_country_obj = '';
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * @param string               $address
+	 * @param string               $address2
+	 * @param string               $city
+	 * @param \EE_State | string   $state
+	 * @param string               $zip
+	 * @param \EE_Country | string $country
+	 * @return GenericAddress
+	 */
+	public function __construct($address, $address2, $city, $state, $zip, $country)
+	{
+		$this->_address = $address;
+		$this->_address2 = $address2;
+		$this->_city = $city;
+		if ($state instanceof \EE_State) {
+			$this->_state_obj = $state;
+		} else {
+			$this->_state_ID = $state;
+			$this->_state_obj = $this->_get_state_obj();
+		}
+		$this->_zip = $zip;
+		if ($country instanceof \EE_Country) {
+			$this->_country_obj = $country;
+		} else {
+			$this->_country_ID = $country;
+			$this->_country_obj = $this->_get_country_obj();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->_address;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->_address2;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->_city;
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * @return \EE_State
+	 */
+	private function _get_state_obj()
+	{
+		return $this->_state_obj instanceof \EE_State
+			? $this->_state_obj
+			: \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_ID()
+	{
+		return $this->_state_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->abbrev()
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->_state_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_obj()->abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	private function _get_country_obj()
+	{
+		return $this->_country_obj instanceof \EE_Country
+			? $this->_country_obj
+			: \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->_country_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name()
+	{
+		return $this->country_obj() instanceof \EE_Country
+			? $this->country_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->_country_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->_zip;
+	}
 }

core/domain/services/registration/CreateRegistrationService.php

Doc Comments +2 added lines, -2 removed lines

@@ -34,8 +34,8 @@
      * @param EE_Transaction  $transaction
      * @param EE_Ticket       $ticket
      * @param EE_Line_Item    $ticket_line_item
-     * @param                 $reg_count
-     * @param                 $reg_group_size
+     * @param                 integer $reg_count
+     * @param                 integer $reg_group_size
      * @param string          $reg_status
      * @return EE_Registration
      * @throws OutOfRangeException

Indentation +94 added lines, -94 removed lines

@@ -29,102 +29,102 @@
 {
 
 
-    /**
-     * @param EE_Event        $event
-     * @param EE_Transaction  $transaction
-     * @param EE_Ticket       $ticket
-     * @param EE_Line_Item    $ticket_line_item
-     * @param                 $reg_count
-     * @param                 $reg_group_size
-     * @param string          $reg_status
-     * @return EE_Registration
-     * @throws OutOfRangeException
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function create(
-        EE_Event $event,
-        EE_Transaction $transaction,
-        EE_Ticket $ticket,
-        EE_Line_Item $ticket_line_item,
-        $reg_count,
-        $reg_group_size,
-        $reg_status = EEM_Registration::status_id_incomplete
-    ) {
-        $registrations = $transaction->registrations();
-        $reg_count = $reg_count ? $reg_count : count($registrations) + 1;
-        $reg_url_link = new RegUrlLink($reg_count, $ticket_line_item);
-        $reg_code = new RegCode($reg_url_link, $transaction, $ticket);
-        // generate new EE_Registration
-        $registration = EE_Registration::new_instance(
-            array(
-                'EVT_ID'          => $event->ID(),
-                'TXN_ID'          => $transaction->ID(),
-                'TKT_ID'          => $ticket->ID(),
-                'STS_ID'          => $reg_status,
-                'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item),
-                'REG_session'     => EE_Registry::instance()->SSN->id(),
-                'REG_count'       => $reg_count,
-                'REG_group_size'  => $reg_group_size ? $reg_group_size : $this->incrementRegCount($registrations),
-                'REG_url_link'    => $reg_url_link,
-                'REG_code'        => $reg_code,
-            )
-        );
-        if (! $registration instanceof EE_Registration) {
-            throw new UnexpectedEntityException($registration, 'EE_Registration');
-        }
-        // save registration so that we have an ID
-        $registration->save();
-        // track reservation on reg but don't adjust ticket and datetime reserved counts
-        // because that is done as soon as the tickets are added/removed from the cart
-        $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
-        $registration->_add_relation_to($event, 'Event', array(), $event->ID());
-        $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
-        $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());
-        $registration->save();
-        return $registration;
-    }
+	/**
+	 * @param EE_Event        $event
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Ticket       $ticket
+	 * @param EE_Line_Item    $ticket_line_item
+	 * @param                 $reg_count
+	 * @param                 $reg_group_size
+	 * @param string          $reg_status
+	 * @return EE_Registration
+	 * @throws OutOfRangeException
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function create(
+		EE_Event $event,
+		EE_Transaction $transaction,
+		EE_Ticket $ticket,
+		EE_Line_Item $ticket_line_item,
+		$reg_count,
+		$reg_group_size,
+		$reg_status = EEM_Registration::status_id_incomplete
+	) {
+		$registrations = $transaction->registrations();
+		$reg_count = $reg_count ? $reg_count : count($registrations) + 1;
+		$reg_url_link = new RegUrlLink($reg_count, $ticket_line_item);
+		$reg_code = new RegCode($reg_url_link, $transaction, $ticket);
+		// generate new EE_Registration
+		$registration = EE_Registration::new_instance(
+			array(
+				'EVT_ID'          => $event->ID(),
+				'TXN_ID'          => $transaction->ID(),
+				'TKT_ID'          => $ticket->ID(),
+				'STS_ID'          => $reg_status,
+				'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item),
+				'REG_session'     => EE_Registry::instance()->SSN->id(),
+				'REG_count'       => $reg_count,
+				'REG_group_size'  => $reg_group_size ? $reg_group_size : $this->incrementRegCount($registrations),
+				'REG_url_link'    => $reg_url_link,
+				'REG_code'        => $reg_code,
+			)
+		);
+		if (! $registration instanceof EE_Registration) {
+			throw new UnexpectedEntityException($registration, 'EE_Registration');
+		}
+		// save registration so that we have an ID
+		$registration->save();
+		// track reservation on reg but don't adjust ticket and datetime reserved counts
+		// because that is done as soon as the tickets are added/removed from the cart
+		$registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
+		$registration->_add_relation_to($event, 'Event', array(), $event->ID());
+		$registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
+		$transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());
+		$registration->save();
+		return $registration;
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param EE_Ticket      $ticket
-     * @param EE_Line_Item   $ticket_line_item
-     * @return float
-     * @throws EE_Error
-     * @throws OutOfRangeException
-     */
-    protected function resolveFinalPrice(
-        EE_Transaction $transaction,
-        EE_Ticket $ticket,
-        EE_Line_Item $ticket_line_item
-    ) {
-        $final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item(
-            $transaction->total_line_item(),
-            $ticket_line_item
-        );
-        $final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes();
-        return (float) $final_price;
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param EE_Ticket      $ticket
+	 * @param EE_Line_Item   $ticket_line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws OutOfRangeException
+	 */
+	protected function resolveFinalPrice(
+		EE_Transaction $transaction,
+		EE_Ticket $ticket,
+		EE_Line_Item $ticket_line_item
+	) {
+		$final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item(
+			$transaction->total_line_item(),
+			$ticket_line_item
+		);
+		$final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes();
+		return (float) $final_price;
+	}
 
 
-    /**
-     * @param  EE_Registration[] $registrations
-     * @param  boolean           $update_existing_registrations
-     * @return int
-     * @throws EE_Error
-     */
-    protected function incrementRegCount(array $registrations, $update_existing_registrations = true)
-    {
-        $new_reg_count = count($registrations) + 1;
-        if ($update_existing_registrations) {
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_count($new_reg_count);
-                    $registration->save();
-                }
-            }
-        }
-        return $new_reg_count;
-    }
+	/**
+	 * @param  EE_Registration[] $registrations
+	 * @param  boolean           $update_existing_registrations
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function incrementRegCount(array $registrations, $update_existing_registrations = true)
+	{
+		$new_reg_count = count($registrations) + 1;
+		if ($update_existing_registrations) {
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration->set_count($new_reg_count);
+					$registration->save();
+				}
+			}
+		}
+		return $new_reg_count;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -70,14 +70,14 @@
                 'REG_code'        => $reg_code,
             )
         );
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new UnexpectedEntityException($registration, 'EE_Registration');
         }
         // save registration so that we have an ID
         $registration->save();
         // track reservation on reg but don't adjust ticket and datetime reserved counts
         // because that is done as soon as the tickets are added/removed from the cart
-        $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
+        $registration->reserve_ticket(false, 'CreateRegistrationService:'.__LINE__);
         $registration->_add_relation_to($event, 'Event', array(), $event->ID());
         $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
         $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());

core/libraries/batch/JobHandlers/AttendeesReport.php

Doc Comments +4 added lines

@@ -90,6 +90,10 @@
         return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
     }
 
+    /**
+     * @param integer $offset
+     * @param integer $limit
+     */
     public function get_csv_data($offset, $limit)
     {
         $attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results(

Indentation +96 added lines, -96 removed lines

@@ -19,106 +19,106 @@
 class AttendeesReport extends JobHandlerFile
 {
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    public function create_job(JobParameters $job_parameters)
-    {
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
-            throw new BatchRequestException(
-                __('You do not have permission to view contacts', 'event_espresso')
-            );
-        }
-        $filepath = $this->create_file_from_job_with_name(
-            $job_parameters->job_id(),
-            __('contact-list-report.csv', 'event_espresso')
-        );
-        $job_parameters->add_extra_data('filepath', $filepath);
-        $job_parameters->set_job_size($this->count_units_to_process());
-        // we should also set the header columns
-        $csv_data_for_row = $this->get_csv_data(0, 1);
-        \EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
-        // if we actually processed a row there, record it
-        if ($job_parameters->job_size()) {
-            $job_parameters->mark_processed(1);
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            __('Contacts report started successfully...', 'event_espresso')
-        );
-    }
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	public function create_job(JobParameters $job_parameters)
+	{
+		if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
+			throw new BatchRequestException(
+				__('You do not have permission to view contacts', 'event_espresso')
+			);
+		}
+		$filepath = $this->create_file_from_job_with_name(
+			$job_parameters->job_id(),
+			__('contact-list-report.csv', 'event_espresso')
+		);
+		$job_parameters->add_extra_data('filepath', $filepath);
+		$job_parameters->set_job_size($this->count_units_to_process());
+		// we should also set the header columns
+		$csv_data_for_row = $this->get_csv_data(0, 1);
+		\EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true);
+		// if we actually processed a row there, record it
+		if ($job_parameters->job_size()) {
+			$job_parameters->mark_processed(1);
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			__('Contacts report started successfully...', 'event_espresso')
+		);
+	}
 
 
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50)
-    {
-        $csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size);
-        \EEH_Export::write_data_array_to_csv(
-            $job_parameters->extra_datum('filepath'),
-            $csv_data,
-            false
-        );
-        $units_processed = count($csv_data);
-        $job_parameters->mark_processed($units_processed);
-        $extra_response_data = array(
-            'file_url' => '',
-        );
-        if ($units_processed < $batch_size) {
-            $job_parameters->set_status(JobParameters::status_complete);
-            $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
-        }
-        return new JobStepResponse(
-            $job_parameters,
-            sprintf(
-                __('Wrote %1$s rows to report CSV file...', 'event_espresso'),
-                count($csv_data)
-            ),
-            $extra_response_data
-        );
-    }
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50)
+	{
+		$csv_data = $this->get_csv_data($job_parameters->units_processed(), $batch_size);
+		\EEH_Export::write_data_array_to_csv(
+			$job_parameters->extra_datum('filepath'),
+			$csv_data,
+			false
+		);
+		$units_processed = count($csv_data);
+		$job_parameters->mark_processed($units_processed);
+		$extra_response_data = array(
+			'file_url' => '',
+		);
+		if ($units_processed < $batch_size) {
+			$job_parameters->set_status(JobParameters::status_complete);
+			$extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath'));
+		}
+		return new JobStepResponse(
+			$job_parameters,
+			sprintf(
+				__('Wrote %1$s rows to report CSV file...', 'event_espresso'),
+				count($csv_data)
+			),
+			$extra_response_data
+		);
+	}
 
 
-    public function cleanup_job(JobParameters $job_parameters)
-    {
-        $this->_file_helper->delete(
-            \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
-            true,
-            'd'
-        );
-        return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
-    }
+	public function cleanup_job(JobParameters $job_parameters)
+	{
+		$this->_file_helper->delete(
+			\EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')),
+			true,
+			'd'
+		);
+		return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso'));
+	}
 
-    public function count_units_to_process()
-    {
-        return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
-    }
+	public function count_units_to_process()
+	{
+		return \EEM_Attendee::instance()->count(array('caps' => \EEM_Base::caps_read_admin));
+	}
 
-    public function get_csv_data($offset, $limit)
-    {
-        $attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results(
-            array(
-                'limit'      => array($offset, $limit),
-                'force_join' => array('State', 'Country'),
-                'caps'       => \EEM_Base::caps_read_admin,
-            )
-        );
-        $csv_data = array();
-        foreach ($attendee_rows as $attendee_row) {
-            $csv_row = array();
-            foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
-                if ($field_name == 'STA_ID') {
-                    $state_name_field = \EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ];
-                } elseif ($field_name == 'CNT_ISO') {
-                    $country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ];
-                } else {
-                    $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
-                }
-            }
-            $csv_data[] = apply_filters(
-                'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row',
-                $csv_row,
-                $attendee_row
-            );
-        }
-        return $csv_data;
-    }
+	public function get_csv_data($offset, $limit)
+	{
+		$attendee_rows = \EEM_Attendee::instance()->get_all_wpdb_results(
+			array(
+				'limit'      => array($offset, $limit),
+				'force_join' => array('State', 'Country'),
+				'caps'       => \EEM_Base::caps_read_admin,
+			)
+		);
+		$csv_data = array();
+		foreach ($attendee_rows as $attendee_row) {
+			$csv_row = array();
+			foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
+				if ($field_name == 'STA_ID') {
+					$state_name_field = \EEM_State::instance()->field_settings_for('STA_name');
+					$csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ];
+				} elseif ($field_name == 'CNT_ISO') {
+					$country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name');
+					$csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+				} else {
+					$csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
+				}
+			}
+			$csv_data[] = apply_filters(
+				'FHEE___EventEspresso_core_libraries_batch_JobHandlers_AttendeesReport__get_csv_data__row',
+				$csv_row,
+				$attendee_row
+			);
+		}
+		return $csv_data;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
     // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
     public function create_job(JobParameters $job_parameters)
     {
-        if (! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
+        if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_contacts', 'generating_report')) {
             throw new BatchRequestException(
                 __('You do not have permission to view contacts', 'event_espresso')
             );
@@ -105,12 +105,12 @@ 
             foreach (\EEM_Attendee::instance()->field_settings() as $field_name => $field_obj) {
                 if ($field_name == 'STA_ID') {
                     $state_name_field = \EEM_State::instance()->field_settings_for('STA_name');
-                    $csv_row[ __('State', 'event_espresso') ] = $attendee_row[ $state_name_field->get_qualified_column() ];
+                    $csv_row[__('State', 'event_espresso')] = $attendee_row[$state_name_field->get_qualified_column()];
                 } elseif ($field_name == 'CNT_ISO') {
                     $country_name_field = \EEM_Country::instance()->field_settings_for('CNT_name');
-                    $csv_row[ __('Country', 'event_espresso') ] = $attendee_row[ $country_name_field->get_qualified_column() ];
+                    $csv_row[__('Country', 'event_espresso')] = $attendee_row[$country_name_field->get_qualified_column()];
                 } else {
-                    $csv_row[ wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES) ] = $attendee_row[ $field_obj->get_qualified_column() ];
+                    $csv_row[wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES)] = $attendee_row[$field_obj->get_qualified_column()];
                 }
             }
             $csv_data[] = apply_filters(

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

Doc Comments +2 added lines, -2 removed lines

@@ -356,7 +356,7 @@ 
      * Sets sensitive_data_removal_strategy
      *
      * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
-     * @return boolean
+     * @return boolean|null
      */
     public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
     {
@@ -476,7 +476,7 @@ 
     /**
      * returns true if input employs any of the validation strategy defined by the supplied array of classnames
      *
-     * @param array $validation_strategy_classnames
+     * @param string[] $validation_strategy_classnames
      * @return bool
      */
     public function has_validation_strategy($validation_strategy_classnames)

Indentation +1236 added lines, -1236 removed lines

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

Spacing +20 added lines, -20 removed lines

@@ -202,7 +202,7 @@ 
         if (isset($input_args['validation_strategies'])) {
             foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
                 if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+                    $this->_validation_strategies[get_class($validation_strategy)] = $validation_strategy;
                 }
             }
             unset($input_args['validation_strategies']);
@@ -213,7 +213,7 @@ 
         // loop thru incoming options
         foreach ($input_args as $key => $value) {
             // add underscore to $key to match property names
-            $_key = '_' . $key;
+            $_key = '_'.$key;
             if (property_exists($this, $_key)) {
                 $this->{$_key} = $value;
             }
@@ -233,7 +233,7 @@ 
         if (isset($input_args['ignore_input'])) {
             $this->_normalization_strategy = new EE_Null_Normalization();
         }
-        if (! $this->_normalization_strategy) {
+        if ( ! $this->_normalization_strategy) {
                 $this->_normalization_strategy = new EE_Text_Normalization();
         }
         $this->_normalization_strategy->_construct_finalize($this);
@@ -242,7 +242,7 @@ 
             $this->set_default($input_args['default']);
             unset($input_args['default']);
         }
-        if (! $this->_sensitive_data_removal_strategy) {
+        if ( ! $this->_sensitive_data_removal_strategy) {
             $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
         }
         $this->_sensitive_data_removal_strategy->_construct_finalize($this);
@@ -259,10 +259,10 @@ 
      */
     protected function _set_default_html_name_if_empty()
     {
-        if (! $this->_html_name) {
+        if ( ! $this->_html_name) {
             $this->_html_name = $this->name();
             if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+                $this->_html_name = $this->_parent_section->html_name_prefix()."[{$this->name()}]";
             }
         }
     }
@@ -294,7 +294,7 @@ 
     protected function _get_display_strategy()
     {
         $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+        if ( ! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -461,7 +461,7 @@ 
             if ($validation_strategy instanceof $validation_strategy_classname
                 || is_subclass_of($validation_strategy, $validation_strategy_classname)
             ) {
-                unset($this->_validation_strategies[ $key ]);
+                unset($this->_validation_strategies[$key]);
             }
         }
     }
@@ -526,7 +526,7 @@ 
      */
     public function html_other_attributes()
     {
-        return ! empty($this->_html_other_attributes) ? ' ' . $this->_html_other_attributes : '';
+        return ! empty($this->_html_other_attributes) ? ' '.$this->_html_other_attributes : '';
     }
 
 
@@ -648,7 +648,7 @@ 
             if (is_array($raw_input)) {
                 $raw_value = array();
                 foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
+                    $raw_value[$key] = $this->_sanitize($value);
                 }
                 $this->_set_raw_value($raw_value);
             } else {
@@ -681,7 +681,7 @@ 
      */
     public function html_label_id()
     {
-        return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id() . '-lbl';
+        return ! empty($this->_html_label_id) ? $this->_html_label_id : $this->html_id().'-lbl';
     }
 
 
@@ -831,9 +831,9 @@ 
                 $validation_strategy->get_jquery_validation_rule_array()
             );
         }
-        if (! empty($jquery_validation_rules)) {
+        if ( ! empty($jquery_validation_rules)) {
             foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+                $jquery_validation_js[$html_id_with_pound_sign] = $jquery_validation_rules;
             }
         }
         return $jquery_validation_js;
@@ -955,7 +955,7 @@ 
     public function html_class($add_required = false)
     {
         return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
+            ? $this->required_css_class().' '.$this->_html_class
             : $this->_html_class;
     }
 
@@ -1029,7 +1029,7 @@ 
                 $button_css_attributes .= '';
         }
         $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
+            ? $button_css_attributes.' '.$other_attributes
             : $button_css_attributes;
     }
 
@@ -1067,8 +1067,8 @@ 
         // now get the value for the input
         $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
         // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
+        if ($value === null && isset($req_data[$this->name()])) {
+            $value = $req_data[$this->name()];
         }
         return $value;
     }
@@ -1109,13 +1109,13 @@ 
     public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
     {
         $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
+        if (isset($req_data[$first_part_to_consider])) {
             if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
+                return $req_data[$first_part_to_consider];
             } else {
                 return $this->findRequestForSectionUsingNameParts(
                     $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
+                    $req_data[$first_part_to_consider]
                 );
             }
         } else {

core/libraries/rest_api/controllers/model/Read.php

Doc Comments +1 added lines, -1 removed lines

@@ -1306,7 +1306,7 @@
      *
      * @param EEM_Base        $model
      * @param WP_REST_Request $request
-     * @param null            $context
+     * @param string            $context
      * @return array|WP_Error
      */
     public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)

Spacing +53 added lines, -53 removed lines

@@ -73,7 +73,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -114,7 +114,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return array();
             }
             // get the model for this version
@@ -171,11 +171,11 @@ 
      */
     protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
     {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+        if (isset($schema['properties'][$field_name]['default'])) {
+            if (is_array($schema['properties'][$field_name]['default'])) {
+                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
                     if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -184,9 +184,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -208,9 +208,9 @@ 
     protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
     {
         if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+            $schema['properties'][$field_name.'_gmt'] = $field->getSchema();
             // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+            $schema['properties'][$field_name.'_gmt']['description'] = sprintf(
                 esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -253,7 +253,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -326,7 +326,7 @@ 
     public function getEntitiesFromModel($model, $request)
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             return new WP_Error(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -338,7 +338,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
@@ -373,7 +373,7 @@ 
         $context = $this->validateContext($request->get_param('caps'));
         $model = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = array();
         }
         // check if they can access the 1st model object
@@ -390,7 +390,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('main model query params', $restricted_query_params);
         $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
+        if ( ! (
             Capabilities::currentUserHasPartialAccessTo($related_model, $context)
             && $model->exists($restricted_query_params)
         )
@@ -423,13 +423,13 @@ 
         }
         $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
         foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -480,7 +480,7 @@ 
      */
     public function getEntitiesFromRelation($id, $relation, $request)
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -522,7 +522,7 @@ 
             Capabilities::getMissingPermissionsString($model, $query_params['caps'])
         );
         // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -555,7 +555,7 @@ 
      */
     public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
     {
-        if (! $rest_request instanceof WP_REST_Request) {
+        if ( ! $rest_request instanceof WP_REST_Request) {
             // ok so this was called in the old style, where the 3rd arg was
             // $include, and the 4th arg was $context
             // now setup the request just to avoid fatal errors, although we won't be able
@@ -636,8 +636,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
+            $post = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof \WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -647,7 +647,7 @@ 
                     )
                 );
             }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
+            $model_object_classname = 'EE_'.$model->get_this_model_name();
             $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
                 $model_object_classname,
                 $result,
@@ -658,13 +658,13 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif ($this->isSubclassOfOne(
                 $field_obj,
                 $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -673,7 +673,7 @@ 
                 $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -704,10 +704,10 @@ 
                         $this->getModelVersionInfo()->requestedVersion()
                     );
                 }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
+                $result[$field_name.'_gmt'] = $gmt_date;
+                $result[$field_name] = $local_date;
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -759,7 +759,7 @@ 
     protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
     {
         if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -784,7 +784,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ),
             );
@@ -800,12 +800,12 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+                $links[EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -834,13 +834,13 @@ 
         $db_row = array()
     ) {
         // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
         // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -886,7 +886,7 @@ 
                     $relation_obj,
                     $pretend_related_request
                 );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results
                                                                                              instanceof
                                                                                              WP_Error
                     ? null
@@ -1018,7 +1018,7 @@ 
      */
     public function validateContext($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1043,7 +1043,7 @@ 
             EEM_Base::default_where_conditions_minimum_all,
             EEM_Base::default_where_conditions_minimum_others,
         );
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = EEM_Base::default_where_conditions_all;
         }
         if (in_array(
@@ -1126,14 +1126,14 @@ 
         }
         if (isset($query_parameters['limit'])) {
             // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
+            if ( ! is_array($query_parameters['limit'])) {
                 $limit_array = explode(',', (string) $query_parameters['limit']);
             } else {
                 $limit_array = $query_parameters['limit'];
             }
             $sanitized_limit = array();
             foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -1179,9 +1179,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsKeyForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1199,9 +1199,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1233,17 +1233,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 // does this item have a period?
                 if (strpos($item, '.') === false) {
                     // if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (strpos($item, $prefix.'.') === 0) {
                 // this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1282,9 +1282,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include == $model_name) {
                     $extracted_fields_to_include[] = '*';
@@ -1324,7 +1324,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
+        if ( ! empty($model_rows)) {
             return $this->createEntityFromWpdbResult(
                 $model,
                 array_shift($model_rows),
@@ -1334,10 +1334,10 @@ 
             // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
             $lowercase_model_name = strtolower($model->get_this_model_name());
             $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
+            if ( ! empty($model_rows_found_sans_restrictions)) {
                 // you got shafted- it existed but we didn't want to tell you!
                 return new WP_Error(
-                    'rest_user_cannot_' . $context,
+                    'rest_user_cannot_'.$context,
                     sprintf(
                         __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                         $context,

Indentation +1319 added lines, -1319 removed lines

@@ -40,1323 +40,1323 @@
 {
 
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     * @param CalculatedModelFields $fields_calculator
-     */
-    public function __construct(CalculatedModelFields $fields_calculator)
-    {
-        parent::__construct();
-        $this->fields_calculator = $fields_calculator;
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleSchemaRequest($version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return array();
-            }
-            // get the model for this version
-            $model = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema($model, LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields'));
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (Exception $e) {
-            return array();
-        }
-    }
-
-
-    /**
-     * This loops through each field in the given schema for the model and does the following:
-     * - add any extra fields that are REST API specific and related to existing fields.
-     * - transform default values into the correct format for a REST API response.
-     *
-     * @param EEM_Base $model
-     * @param array    $schema
-     * @return array  The final schema.
-     */
-    protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
-                    if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
-            // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest()
-    {
-        if (isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof \WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        } else {
-            return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
-        }
-    }
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @param string $related_model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        $version,
-        $model_name,
-        $related_model_name
-    ) {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            $main_model = $controller->validateModel($model_name);
-            $controller->validateModel($related_model_name);
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array|WP_Error
-     */
-    public function getEntitiesFromModel($model, $request)
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            return new WP_Error(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param array                   $primary_model_query_params query params for finding the item from which
-     *                                                            relations will be based
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return WP_Error|array
-     * @throws RestException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        $model = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = array();
-        }
-        // check if they can access the 1st model object
-        $primary_model_query_params = array(
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        );
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
-                $primary_model_query_params
-            );
-        }
-        $restricted_query_params = $primary_model_query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
-            Capabilities::currentUserHasPartialAccessTo($related_model, $context)
-            && $model->exists($restricted_query_params)
-        )
-        ) {
-            if ($relation instanceof EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
-                    $related_model->get_this_model_name()
-                );
-            }
-            return new WP_Error(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    __(
-                        'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'
-                    ),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
-                              . '.'
-                              . $where_condition_key ] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->createEntityFromWpdbResult(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof \EE_HABTM_Relation) {
-                // put the unusual stuff (properties from the HABTM relation) first, and make sure
-                // if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->createEntityFromWpdbResult(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($nice_result, $join_model_result);
-                // but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                  $id the ID of the thing we are fetching related stuff from
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return array|WP_Error
-     * @throws EE_Error
-     */
-    public function getEntitiesFromRelation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            array(
-                array(
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ),
-            ),
-            $relation,
-            $request
-        );
-    }
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @return void
-     */
-    protected function setHeadersFromQueryParams($model, $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-        );
-        // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = array(0, $limit_parts[0]);
-            }
-        }
-        // remove the group by and having parts of the query, as those will
-        // make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('TotalPages', ceil($pages), false);
-    }
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param EEM_Base        $model
-     * @param array           $db_row     like results from $wpdb->get_results()
-     * @param WP_REST_Request $rest_request
-     * @param string          $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     */
-    public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
-    {
-        if (! $rest_request instanceof WP_REST_Request) {
-            // ok so this was called in the old style, where the 3rd arg was
-            // $include, and the 4th arg was $context
-            // now setup the request just to avoid fatal errors, although we won't be able
-            // to truly make use of it because it's kinda devoid of info
-            $rest_request = new WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') == null) {
-            $rest_request->set_param('caps', EEM_Base::caps_read);
-        }
-        $entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->getModelVersionInfo(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->setDebugInfo(
-            'inaccessible fields',
-            array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     */
-    protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof \EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                // if the value is null, but we're not supposed to permit null, then set to the field's default
-                if (is_null($field_value)) {
-                    $field_value = $field_obj->getDefaultDateTimeObj();
-                }
-                if (is_null($field_value)) {
-                    $gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                } else {
-                    $timezone = $field_value->getTimezone();
-                    EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                    $gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                    EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                    $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return mixed
-     * @throws ObjectDetectedException if $value contains a PHP object
-     */
-    protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
-    {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @param array    $entity_array
-     * @return array modified entity
-     */
-    protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
-    {
-        if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @global \WP_REST_Server $wp_rest_server
-     * @param EEM_Base         $model
-     * @param array            $db_row
-     * @param array            $entity_array
-     * @return array the _links item in the entity
-     */
-    protected function getEntityLinks($model, $db_row, $entity_array)
-    {
-        // add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
-                    array(
-                        'href'   => $this->getVersionedLinkTo(
-                            EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[ $model->primary_key_name() ]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
-                    ),
-                );
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $rest_request
-     * @param array           $entity_array
-     * @param array           $db_row
-     * @return array the modified entity
-     */
-    protected function includeRequestedModels(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        $entity_array,
-        $db_row = array()
-    ) {
-        // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
-        // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                // always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            // did they specify they wanted to include a related model, or
-            // specific fields from a related model?
-            // or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                // if so, we should include at least some part of the related model
-                $pretend_related_request = new WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    array(
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                    )
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
-                                                                                             instanceof
-                                                                                             WP_Error
-                    ? null
-                    : $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $arr
-     * @return array
-     */
-    private function removeModelNamesFromArray($arr)
-    {
-        return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $rest_request
-     * @return \stdClass the _calculations item in the entity
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function getEntityCalculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        // note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new \stdClass();
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                $calculated_fields_to_return->$field_to_calculate = ModelDataTranslator::prepareFieldValueForJson(
-                    null,
-                    $this->fields_calculator->retrieveCalculatedFieldValue(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    true
-                );
-            }
-        }
-        return $calculated_fields_to_return;
-    }
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     */
-    public function getVersionedLinkTo($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                  $relation_name
-     * @param \EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function getRelatedEntityName($relation_name, $relation_obj)
-    {
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array|WP_Error
-     */
-    public function getEntityFromModel($model, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validateContext($context)
-    {
-        if (! $context) {
-            $context = EEM_Base::caps_read;
-        }
-        $valid_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return EEM_Base::caps_read;
-        }
-    }
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validateDefaultQueryParams($default_query_params)
-    {
-        $valid_default_where_conditions_for_api_calls = array(
-            EEM_Base::default_where_conditions_all,
-            EEM_Base::default_where_conditions_minimum_all,
-            EEM_Base::default_where_conditions_minimum_others,
-        );
-        if (! $default_query_params) {
-            $default_query_params = EEM_Base::default_where_conditions_all;
-        }
-        if (in_array(
-            $default_query_params,
-            $valid_default_where_conditions_for_api_calls,
-            true
-        )) {
-            return $default_query_params;
-        } else {
-            return EEM_Base::default_where_conditions_all;
-        }
-    }
-
-
-    /**
-     * Translates API filter get parameter into model query params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
-     * Note: right now the query parameter keys for fields (and related fields)
-     * can be left as-is, but it's quite possible this will change someday.
-     * Also, this method's contents might be candidate for moving to Model_Data_Translator
-     *
-     * @param EEM_Base $model
-     * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
-     * @return array model query params (@see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
-     *                                    or FALSE to indicate that absolutely no results should be returned
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function createModelQueryParams($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_parameters['order_by'])) {
-            $order_by = $query_parameters['order_by'];
-        } elseif (isset($query_parameters['orderby'])) {
-            $order_by = $query_parameters['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_parameters['group_by'])) {
-            $group_by = $query_parameters['group_by'];
-        } elseif (isset($query_parameters['groupby'])) {
-            $group_by = $query_parameters['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        // make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_parameters['order'])) {
-            $model_query_params['order'] = $query_parameters['order'];
-        }
-        if (isset($query_parameters['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_parameters['limit'])) {
-            // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string) $query_parameters['limit']);
-            } else {
-                $limit_array = $query_parameters['limit'];
-            }
-            $sanitized_limit = array();
-            foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                            // @codingStandardsIgnoreStart
-                                'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($query_parameters['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int) $limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_parameters['caps'])) {
-            $model_query_params['caps'] = $this->validateContext($query_parameters['caps']);
-        } else {
-            $model_query_params['caps'] = EEM_Base::caps_read;
-        }
-        if (isset($query_parameters['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
-                $query_parameters['default_where_conditions']
-            );
-        }
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
-    }
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @deprecated
-     * @param EEM_Base $model
-     * @param array    $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     */
-    public function prepareRestQueryParamsKeyForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = array();
-        }
-        // if the string was empty, we want an empty array
-        $exploded_contents = array_filter($exploded_contents);
-        $contents_with_prefix = array();
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                // does this item have a period?
-                if (strpos($item, '.') === false) {
-                    // if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($item === $prefix) {
-                // this item is JUST the prefix
-                // so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-    /**
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     * Deprecated because its return values were really quite confusing- sometimes it returned
-     * an empty array (when the include string was blank or '*') or sometimes it returned
-     * array('*') (when you provided a model and a model of that kind was found).
-     * Parses the $include_string so we fetch all the field names relating to THIS model
-     * (ie have NO period in them), or for the provided model (ie start with the model
-     * name and then a period).
-     * @param string $include_string @see Read:handle_request_get_all
-     * @param string $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                               the fields for that model, with the model's name removed from each.
-     *                               If $include_string was blank or '*' returns an empty array
-     */
-    public function extractIncludesForThisModel($include_string, $model_name = null)
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return array();
-        }
-        $includes = explode(',', $include_string);
-        $extracted_fields_to_include = array();
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include == $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            // look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, '.') === false
-                    && ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param null            $context
-     * @return array|WP_Error
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
-    {
-        $query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
-        if ($model instanceof \EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params = $query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $model,
-                array_shift($model_rows),
-                $request
-            );
-        } else {
-            // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
-                // you got shafted- it existed but we didn't want to tell you!
-                return new WP_Error(
-                    'rest_user_cannot_' . $context,
-                    sprintf(
-                        __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                        $context,
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::getMissingPermissionsString(
-                            $model,
-                            $context
-                        )
-                    ),
-                    array('status' => 403)
-                );
-            } else {
-                // it's not you. It just doesn't exist
-                return new WP_Error(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    array('status' => 404)
-                );
-            }
-        }
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(CalculatedModelFields $fields_calculator)
+	{
+		parent::__construct();
+		$this->fields_calculator = $fields_calculator;
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleSchemaRequest($version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return array();
+			}
+			// get the model for this version
+			$model = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema($model, LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields'));
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (Exception $e) {
+			return array();
+		}
+	}
+
+
+	/**
+	 * This loops through each field in the given schema for the model and does the following:
+	 * - add any extra fields that are REST API specific and related to existing fields.
+	 * - transform default values into the correct format for a REST API response.
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $schema
+	 * @return array  The final schema.
+	 */
+	protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if (isset($schema['properties'][ $field_name ]['default'])) {
+			if (is_array($schema['properties'][ $field_name ]['default'])) {
+				foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+					if ($default_key === 'raw') {
+						$schema['properties'][ $field_name ]['default'][ $default_key ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+			// modify the description
+			$schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest()
+	{
+		if (isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof \WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		} else {
+			return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
+		}
+	}
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @param string $related_model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		$version,
+		$model_name,
+		$related_model_name
+	) {
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			$main_model = $controller->validateModel($model_name);
+			$controller->validateModel($related_model_name);
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array|WP_Error
+	 */
+	public function getEntitiesFromModel($model, $request)
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			return new WP_Error(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param array                   $primary_model_query_params query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return WP_Error|array
+	 * @throws RestException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		$model = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = array();
+		}
+		// check if they can access the 1st model object
+		$primary_model_query_params = array(
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
+				$primary_model_query_params
+			);
+		}
+		$restricted_query_params = $primary_model_query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		if (! (
+			Capabilities::currentUserHasPartialAccessTo($related_model, $context)
+			&& $model->exists($restricted_query_params)
+		)
+		) {
+			if ($relation instanceof EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
+					$related_model->get_this_model_name()
+				);
+			}
+			return new WP_Error(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					__(
+						'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'
+					),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][ $relation->get_this_model()->get_this_model_name()
+							  . '.'
+							  . $where_condition_key ] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps'] = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->createEntityFromWpdbResult(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof \EE_HABTM_Relation) {
+				// put the unusual stuff (properties from the HABTM relation) first, and make sure
+				// if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->createEntityFromWpdbResult(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($nice_result, $join_model_result);
+				// but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                  $id the ID of the thing we are fetching related stuff from
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return array|WP_Error
+	 * @throws EE_Error
+	 */
+	public function getEntitiesFromRelation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			array(
+				array(
+					$relation->get_this_model()->primary_key_name() => $id,
+				),
+			),
+			$relation,
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @return void
+	 */
+	protected function setHeadersFromQueryParams($model, $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+		);
+		// normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = array(0, $limit_parts[0]);
+			}
+		}
+		// remove the group by and having parts of the query, as those will
+		// make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('TotalPages', ceil($pages), false);
+	}
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $db_row     like results from $wpdb->get_results()
+	 * @param WP_REST_Request $rest_request
+	 * @param string          $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 */
+	public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
+	{
+		if (! $rest_request instanceof WP_REST_Request) {
+			// ok so this was called in the old style, where the 3rd arg was
+			// $include, and the 4th arg was $context
+			// now setup the request just to avoid fatal errors, although we won't be able
+			// to truly make use of it because it's kinda devoid of info
+			$rest_request = new WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') == null) {
+			$rest_request->set_param('caps', EEM_Base::caps_read);
+		}
+		$entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		$result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->getModelVersionInfo(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->setDebugInfo(
+			'inaccessible fields',
+			array_keys(array_diff_key($entity_array, $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 */
+	protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof \EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof \WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = \EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				// if the value is null, but we're not supposed to permit null, then set to the field's default
+				if (is_null($field_value)) {
+					$field_value = $field_obj->getDefaultDateTimeObj();
+				}
+				if (is_null($field_value)) {
+					$gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				} else {
+					$timezone = $field_value->getTimezone();
+					EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+					$gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+					EEH_DTT_Helper::setTimezone($field_value, $timezone);
+					$local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$result[ $field_name . '_gmt' ] = $gmt_date;
+				$result[ $field_name ] = $local_date;
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return mixed
+	 * @throws ObjectDetectedException if $value contains a PHP object
+	 */
+	protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
+	{
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @param array    $entity_array
+	 * @return array modified entity
+	 */
+	protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
+	{
+		if ($model instanceof EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @global \WP_REST_Server $wp_rest_server
+	 * @param EEM_Base         $model
+	 * @param array            $db_row
+	 * @param array            $entity_array
+	 * @return array the _links item in the entity
+	 */
+	protected function getEntityLinks($model, $db_row, $entity_array)
+	{
+		// add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+					array(
+						'href'   => $this->getVersionedLinkTo(
+							EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[ $model->primary_key_name() ]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
+					),
+				);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $rest_request
+	 * @param array           $entity_array
+	 * @param array           $db_row
+	 * @return array the modified entity
+	 */
+	protected function includeRequestedModels(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		$entity_array,
+		$db_row = array()
+	) {
+		// if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
+		// if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				// always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		$relation_settings = $this->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			// did they specify they wanted to include a related model, or
+			// specific fields from a related model?
+			// or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				// if so, we should include at least some part of the related model
+				$pretend_related_request = new WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					array(
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+					)
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				$related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+																							 instanceof
+																							 WP_Error
+					? null
+					: $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	private function removeModelNamesFromArray($arr)
+	{
+		return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $rest_request
+	 * @return \stdClass the _calculations item in the entity
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function getEntityCalculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		// note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new \stdClass();
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				$calculated_fields_to_return->$field_to_calculate = ModelDataTranslator::prepareFieldValueForJson(
+					null,
+					$this->fields_calculator->retrieveCalculatedFieldValue(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					true
+				);
+			}
+		}
+		return $calculated_fields_to_return;
+	}
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 */
+	public function getVersionedLinkTo($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                  $relation_name
+	 * @param \EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function getRelatedEntityName($relation_name, $relation_obj)
+	{
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array|WP_Error
+	 */
+	public function getEntityFromModel($model, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validateContext($context)
+	{
+		if (! $context) {
+			$context = EEM_Base::caps_read;
+		}
+		$valid_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return EEM_Base::caps_read;
+		}
+	}
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validateDefaultQueryParams($default_query_params)
+	{
+		$valid_default_where_conditions_for_api_calls = array(
+			EEM_Base::default_where_conditions_all,
+			EEM_Base::default_where_conditions_minimum_all,
+			EEM_Base::default_where_conditions_minimum_others,
+		);
+		if (! $default_query_params) {
+			$default_query_params = EEM_Base::default_where_conditions_all;
+		}
+		if (in_array(
+			$default_query_params,
+			$valid_default_where_conditions_for_api_calls,
+			true
+		)) {
+			return $default_query_params;
+		} else {
+			return EEM_Base::default_where_conditions_all;
+		}
+	}
+
+
+	/**
+	 * Translates API filter get parameter into model query params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
+	 * Note: right now the query parameter keys for fields (and related fields)
+	 * can be left as-is, but it's quite possible this will change someday.
+	 * Also, this method's contents might be candidate for moving to Model_Data_Translator
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
+	 * @return array model query params (@see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
+	 *                                    or FALSE to indicate that absolutely no results should be returned
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function createModelQueryParams($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_parameters['order_by'])) {
+			$order_by = $query_parameters['order_by'];
+		} elseif (isset($query_parameters['orderby'])) {
+			$order_by = $query_parameters['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_parameters['group_by'])) {
+			$group_by = $query_parameters['group_by'];
+		} elseif (isset($query_parameters['groupby'])) {
+			$group_by = $query_parameters['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		// make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_parameters['order'])) {
+			$model_query_params['order'] = $query_parameters['order'];
+		}
+		if (isset($query_parameters['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_parameters['limit'])) {
+			// limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_parameters['limit'])) {
+				$limit_array = explode(',', (string) $query_parameters['limit']);
+			} else {
+				$limit_array = $query_parameters['limit'];
+			}
+			$sanitized_limit = array();
+			foreach ($limit_array as $key => $limit_part) {
+				if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+							// @codingStandardsIgnoreStart
+								'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($query_parameters['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int) $limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_parameters['caps'])) {
+			$model_query_params['caps'] = $this->validateContext($query_parameters['caps']);
+		} else {
+			$model_query_params['caps'] = EEM_Base::caps_read;
+		}
+		if (isset($query_parameters['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
+				$query_parameters['default_where_conditions']
+			);
+		}
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
+	}
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @deprecated
+	 * @param EEM_Base $model
+	 * @param array    $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 */
+	public function prepareRestQueryParamsKeyForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = array();
+		}
+		// if the string was empty, we want an empty array
+		$exploded_contents = array_filter($exploded_contents);
+		$contents_with_prefix = array();
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			// if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				// does this item have a period?
+				if (strpos($item, '.') === false) {
+					// if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($item === $prefix) {
+				// this item is JUST the prefix
+				// so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+	/**
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 * Deprecated because its return values were really quite confusing- sometimes it returned
+	 * an empty array (when the include string was blank or '*') or sometimes it returned
+	 * array('*') (when you provided a model and a model of that kind was found).
+	 * Parses the $include_string so we fetch all the field names relating to THIS model
+	 * (ie have NO period in them), or for the provided model (ie start with the model
+	 * name and then a period).
+	 * @param string $include_string @see Read:handle_request_get_all
+	 * @param string $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                               the fields for that model, with the model's name removed from each.
+	 *                               If $include_string was blank or '*' returns an empty array
+	 */
+	public function extractIncludesForThisModel($include_string, $model_name = null)
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return array();
+		}
+		$includes = explode(',', $include_string);
+		$extracted_fields_to_include = array();
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					// found the model name at the exact start
+					$field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include == $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			// look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, '.') === false
+					&& ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param null            $context
+	 * @return array|WP_Error
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
+	{
+		$query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
+		if ($model instanceof \EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params = $query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$model,
+				array_shift($model_rows),
+				$request
+			);
+		} else {
+			// ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			$model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
+			if (! empty($model_rows_found_sans_restrictions)) {
+				// you got shafted- it existed but we didn't want to tell you!
+				return new WP_Error(
+					'rest_user_cannot_' . $context,
+					sprintf(
+						__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+						$context,
+						strtolower($model->get_this_model_name()),
+						Capabilities::getMissingPermissionsString(
+							$model,
+							$context
+						)
+					),
+					array('status' => 403)
+				);
+			} else {
+				// it's not you. It just doesn't exist
+				return new WP_Error(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					array('status' => 404)
+				);
+			}
+		}
+	}
 }

core/Psr4Autoloader.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
      * Loads the class file for a given class name.
      *
      * @param string $class The fully-qualified class name.
-     * @return mixed The mapped file name on success, or boolean false on
+     * @return string|false The mapped file name on success, or boolean false on
      *                      failure.
      */
     public function loadClass($class)
@@ -153,7 +153,7 @@ 
      *
      * @param string $prefix         The namespace prefix.
      * @param string $relative_class The relative class name.
-     * @return mixed Boolean false if no mapped file can be loaded, or the
+     * @return string|false Boolean false if no mapped file can be loaded, or the
      *                               name of the mapped file that was loaded.
      */
     protected function loadMappedFile($prefix, $relative_class)

Indentation +146 added lines, -146 removed lines

@@ -45,150 +45,150 @@
 class Psr4Autoloader
 {
 
-    /**
-     * namespace separator
-     */
-    const NS = '\\';
-
-    /**
-     * An associative array where the key is a namespace prefix and the value
-     * is an array of base directories for classes in that namespace.
-     *
-     * @var array
-     */
-    protected $prefixes = array();
-
-
-    /**
-     * returns an array of registered namespace prefixes
-     *
-     * @param string $prefix
-     * @return array
-     */
-    public function prefixes($prefix = '')
-    {
-        if (! empty($prefix)) {
-            // are there any base directories for this namespace prefix?
-            return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : array();
-        }
-        return $this->prefixes;
-    }
-
-
-    /**
-     * Register loader with SPL autoloader stack.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        spl_autoload_register(array($this, 'loadClass'));
-    }
-
-
-    /**
-     * Adds a base directory for a namespace prefix.
-     *
-     * @param string $prefix   The namespace prefix.
-     * @param string $base_dir A base directory for class files in the
-     *                         namespace.
-     * @param bool   $prepend  If true, prepend the base directory to the stack
-     *                         instead of appending it; this causes it to be searched first rather
-     *                         than last.
-     * @return void
-     */
-    public function addNamespace($prefix, $base_dir, $prepend = false)
-    {
-        // normalize namespace prefix
-        $prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
-        // normalize the base directory with a trailing separator
-        $base_dir = \EEH_File::standardise_and_end_with_directory_separator($base_dir);
-        // initialize the namespace prefix array
-        if (isset($this->prefixes[ $prefix ]) === false) {
-            $this->prefixes[ $prefix ] = array();
-        }
-        // retain the base directory for the namespace prefix
-        if ($prepend) {
-            array_unshift($this->prefixes[ $prefix ], $base_dir);
-        } else {
-            $this->prefixes[ $prefix ][] = $base_dir;
-        }
-    }
-
-
-    /**
-     * Loads the class file for a given class name.
-     *
-     * @param string $class The fully-qualified class name.
-     * @return mixed The mapped file name on success, or boolean false on
-     *                      failure.
-     */
-    public function loadClass($class)
-    {
-        // the current namespace prefix
-        $prefix = $class;
-        // work backwards through the namespace names of the fully-qualified
-        // class name to find a mapped file name
-        while (false !== $pos = strrpos($prefix, Psr4Autoloader::NS)) {
-            // retain the trailing namespace separator in the prefix
-            $prefix = substr($class, 0, $pos + 1);
-            // the rest is the relative class name
-            $relative_class = substr($class, $pos + 1);
-            // try to load a mapped file for the prefix and relative class
-            $mapped_file = $this->loadMappedFile($prefix, $relative_class);
-            if ($mapped_file) {
-                return $mapped_file;
-            }
-            // remove the trailing namespace separator for the next iteration
-            // of strrpos()
-            $prefix = rtrim($prefix, Psr4Autoloader::NS);
-        }
-        // never found a mapped file
-        return false;
-    }
-
-
-    /**
-     * Load the mapped file for a namespace prefix and relative class.
-     *
-     * @param string $prefix         The namespace prefix.
-     * @param string $relative_class The relative class name.
-     * @return mixed Boolean false if no mapped file can be loaded, or the
-     *                               name of the mapped file that was loaded.
-     */
-    protected function loadMappedFile($prefix, $relative_class)
-    {
-        // look through base directories for this namespace prefix
-        foreach ($this->prefixes($prefix) as $base_dir) {
-            // replace the namespace prefix with the base directory,
-            // replace namespace separators with directory separators
-            // in the relative class name, append with .php
-            $file = $base_dir
-                    . str_replace(Psr4Autoloader::NS, DS, $relative_class)
-                    . '.php';
-            // if the mapped file exists, require it
-            if ($this->requireFile($file)) {
-                // yes, we're done
-                return $file;
-            }
-        }
-        // never found it
-        return false;
-    }
-
-
-    /**
-     * If a file exists, require it from the file system.
-     *
-     * @param string $file The file to require.
-     * @return bool True if the file exists, false if not.
-     */
-    protected function requireFile($file)
-    {
-        if (file_exists($file)) {
-            require $file;
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * namespace separator
+	 */
+	const NS = '\\';
+
+	/**
+	 * An associative array where the key is a namespace prefix and the value
+	 * is an array of base directories for classes in that namespace.
+	 *
+	 * @var array
+	 */
+	protected $prefixes = array();
+
+
+	/**
+	 * returns an array of registered namespace prefixes
+	 *
+	 * @param string $prefix
+	 * @return array
+	 */
+	public function prefixes($prefix = '')
+	{
+		if (! empty($prefix)) {
+			// are there any base directories for this namespace prefix?
+			return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : array();
+		}
+		return $this->prefixes;
+	}
+
+
+	/**
+	 * Register loader with SPL autoloader stack.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		spl_autoload_register(array($this, 'loadClass'));
+	}
+
+
+	/**
+	 * Adds a base directory for a namespace prefix.
+	 *
+	 * @param string $prefix   The namespace prefix.
+	 * @param string $base_dir A base directory for class files in the
+	 *                         namespace.
+	 * @param bool   $prepend  If true, prepend the base directory to the stack
+	 *                         instead of appending it; this causes it to be searched first rather
+	 *                         than last.
+	 * @return void
+	 */
+	public function addNamespace($prefix, $base_dir, $prepend = false)
+	{
+		// normalize namespace prefix
+		$prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
+		// normalize the base directory with a trailing separator
+		$base_dir = \EEH_File::standardise_and_end_with_directory_separator($base_dir);
+		// initialize the namespace prefix array
+		if (isset($this->prefixes[ $prefix ]) === false) {
+			$this->prefixes[ $prefix ] = array();
+		}
+		// retain the base directory for the namespace prefix
+		if ($prepend) {
+			array_unshift($this->prefixes[ $prefix ], $base_dir);
+		} else {
+			$this->prefixes[ $prefix ][] = $base_dir;
+		}
+	}
+
+
+	/**
+	 * Loads the class file for a given class name.
+	 *
+	 * @param string $class The fully-qualified class name.
+	 * @return mixed The mapped file name on success, or boolean false on
+	 *                      failure.
+	 */
+	public function loadClass($class)
+	{
+		// the current namespace prefix
+		$prefix = $class;
+		// work backwards through the namespace names of the fully-qualified
+		// class name to find a mapped file name
+		while (false !== $pos = strrpos($prefix, Psr4Autoloader::NS)) {
+			// retain the trailing namespace separator in the prefix
+			$prefix = substr($class, 0, $pos + 1);
+			// the rest is the relative class name
+			$relative_class = substr($class, $pos + 1);
+			// try to load a mapped file for the prefix and relative class
+			$mapped_file = $this->loadMappedFile($prefix, $relative_class);
+			if ($mapped_file) {
+				return $mapped_file;
+			}
+			// remove the trailing namespace separator for the next iteration
+			// of strrpos()
+			$prefix = rtrim($prefix, Psr4Autoloader::NS);
+		}
+		// never found a mapped file
+		return false;
+	}
+
+
+	/**
+	 * Load the mapped file for a namespace prefix and relative class.
+	 *
+	 * @param string $prefix         The namespace prefix.
+	 * @param string $relative_class The relative class name.
+	 * @return mixed Boolean false if no mapped file can be loaded, or the
+	 *                               name of the mapped file that was loaded.
+	 */
+	protected function loadMappedFile($prefix, $relative_class)
+	{
+		// look through base directories for this namespace prefix
+		foreach ($this->prefixes($prefix) as $base_dir) {
+			// replace the namespace prefix with the base directory,
+			// replace namespace separators with directory separators
+			// in the relative class name, append with .php
+			$file = $base_dir
+					. str_replace(Psr4Autoloader::NS, DS, $relative_class)
+					. '.php';
+			// if the mapped file exists, require it
+			if ($this->requireFile($file)) {
+				// yes, we're done
+				return $file;
+			}
+		}
+		// never found it
+		return false;
+	}
+
+
+	/**
+	 * If a file exists, require it from the file system.
+	 *
+	 * @param string $file The file to require.
+	 * @return bool True if the file exists, false if not.
+	 */
+	protected function requireFile($file)
+	{
+		if (file_exists($file)) {
+			require $file;
+			return true;
+		}
+		return false;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -67,9 +67,9 @@ 
      */
     public function prefixes($prefix = '')
     {
-        if (! empty($prefix)) {
+        if ( ! empty($prefix)) {
             // are there any base directories for this namespace prefix?
-            return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : array();
+            return isset($this->prefixes[$prefix]) ? $this->prefixes[$prefix] : array();
         }
         return $this->prefixes;
     }
@@ -100,18 +100,18 @@ 
     public function addNamespace($prefix, $base_dir, $prepend = false)
     {
         // normalize namespace prefix
-        $prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
+        $prefix = trim($prefix, Psr4Autoloader::NS).Psr4Autoloader::NS;
         // normalize the base directory with a trailing separator
         $base_dir = \EEH_File::standardise_and_end_with_directory_separator($base_dir);
         // initialize the namespace prefix array
-        if (isset($this->prefixes[ $prefix ]) === false) {
-            $this->prefixes[ $prefix ] = array();
+        if (isset($this->prefixes[$prefix]) === false) {
+            $this->prefixes[$prefix] = array();
         }
         // retain the base directory for the namespace prefix
         if ($prepend) {
-            array_unshift($this->prefixes[ $prefix ], $base_dir);
+            array_unshift($this->prefixes[$prefix], $base_dir);
         } else {
-            $this->prefixes[ $prefix ][] = $base_dir;
+            $this->prefixes[$prefix][] = $base_dir;
         }
     }
 

core/services/container/SharedCoffeeMaker.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
     /**
      * @param RecipeInterface $recipe
      * @param array           $arguments
-     * @return mixed
+     * @return boolean
      */
     public function brew(RecipeInterface $recipe, $arguments = array())
     {

Indentation +37 added lines, -37 removed lines

@@ -18,43 +18,43 @@
 {
 
 
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return CoffeeMaker::BREW_SHARED;
-    }
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return CoffeeMaker::BREW_SHARED;
+	}
 
 
-    /**
-     * @param RecipeInterface $recipe
-     * @param array           $arguments
-     * @return mixed
-     */
-    public function brew(RecipeInterface $recipe, $arguments = array())
-    {
-        $this->resolveClassAndFilepath($recipe);
-        $reflector = $this->injector()->getReflectionClass($recipe->fqcn());
-        $method = $this->resolveInstantiationMethod($reflector);
-        switch ($method) {
-            case 'instance':
-            case 'new_instance':
-            case 'new_instance_from_db':
-                $service = call_user_func_array(
-                    array($reflector->getName(), $method),
-                    $this->injector()->resolveDependencies($recipe, $reflector, $arguments)
-                );
-                break;
-            case 'newInstance':
-                $service = $reflector->newInstance();
-                break;
-            case 'newInstanceArgs':
-            default:
-                $service = $reflector->newInstanceArgs(
-                    $this->injector()->resolveDependencies($recipe, $reflector, $arguments)
-                );
-        }
-        return $this->coffeePot()->addService($recipe->identifier(), $service);
-    }
+	/**
+	 * @param RecipeInterface $recipe
+	 * @param array           $arguments
+	 * @return mixed
+	 */
+	public function brew(RecipeInterface $recipe, $arguments = array())
+	{
+		$this->resolveClassAndFilepath($recipe);
+		$reflector = $this->injector()->getReflectionClass($recipe->fqcn());
+		$method = $this->resolveInstantiationMethod($reflector);
+		switch ($method) {
+			case 'instance':
+			case 'new_instance':
+			case 'new_instance_from_db':
+				$service = call_user_func_array(
+					array($reflector->getName(), $method),
+					$this->injector()->resolveDependencies($recipe, $reflector, $arguments)
+				);
+				break;
+			case 'newInstance':
+				$service = $reflector->newInstance();
+				break;
+			case 'newInstanceArgs':
+			default:
+				$service = $reflector->newInstanceArgs(
+					$this->injector()->resolveDependencies($recipe, $reflector, $arguments)
+				);
+		}
+		return $this->coffeePot()->addService($recipe->identifier(), $service);
+	}
 }

core/services/formatters/AsciiOnly.php

Doc Comments +1 added lines, -1 removed lines

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

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace EventEspresso\core\services\formatters;
 
-use EventEspresso\core\exceptions\InvalidDataTypeException;
-
 /**
  * Class AsciiOnly
  * Removes all non-ascii characters from the string

Indentation +52 added lines, -52 removed lines

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

Spacing +9 added lines, -9 removed lines

@@ -39,29 +39,29 @@
     protected function convertAscii($string)
     {
         // Replace Single Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(152);
+        $search[] = chr(226).chr(128).chr(152);
         $replace[] = "'";
-        $search[] = chr(226) . chr(128) . chr(153);
+        $search[] = chr(226).chr(128).chr(153);
         $replace[] = "'";
         // Replace Smart Double Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(156);
+        $search[] = chr(226).chr(128).chr(156);
         $replace[] = '"';
-        $search[] = chr(226) . chr(128) . chr(157);
+        $search[] = chr(226).chr(128).chr(157);
         $replace[] = '"';
         // Replace En Dash
-        $search[] = chr(226) . chr(128) . chr(147);
+        $search[] = chr(226).chr(128).chr(147);
         $replace[] = '--';
         // Replace Em Dash
-        $search[] = chr(226) . chr(128) . chr(148);
+        $search[] = chr(226).chr(128).chr(148);
         $replace[] = '---';
         // Replace Bullet
-        $search[] = chr(226) . chr(128) . chr(162);
+        $search[] = chr(226).chr(128).chr(162);
         $replace[] = '*';
         // Replace Middle Dot
-        $search[] = chr(194) . chr(183);
+        $search[] = chr(194).chr(183);
         $replace[] = '*';
         // Replace Ellipsis with three consecutive dots
-        $search[] = chr(226) . chr(128) . chr(166);
+        $search[] = chr(226).chr(128).chr(166);
         $replace[] = '...';
         // Apply Replacements
         $string = str_replace($search, $replace, $string);

core/services/locators/FqcnLocator.php

Doc Comments +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
      * given a valid namespace, will find all files that match the provided mask
      *
      * @access public
-     * @param string|array $namespaces
+     * @param string $namespaces
      * @return FilesystemIterator
      * @throws \EventEspresso\core\exceptions\InvalidClassException
      * @throws \EventEspresso\core\exceptions\InvalidDataTypeException

Indentation +143 added lines, -143 removed lines

@@ -17,147 +17,147 @@
 class FqcnLocator extends Locator
 {
 
-    /**
-     * @var array $FQCNs
-     */
-    protected $FQCNs = array();
-
-    /**
-     * @var array $namespaces
-     */
-    protected $namespaces = array();
-
-
-    /**
-     * @access protected
-     * @param string $namespace
-     * @param string $namespace_base_dir
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setNamespace($namespace, $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFQCNs()
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @access public
-     * @param string|array $namespaces
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($namespaces)
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @access protected
-     * @param array $partial_namespace
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function FindFQCNsByNamespace($partial_namespace)
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        if (iterator_count($iterator) === 0) {
-            return array();
-        }
-        foreach ($iterator as $file) {
-            $file = \EEH_File::standardise_directory_separators($file);
-            foreach ($this->namespaces as $namespace => $base_dir) {
-                $namespace .= Psr4Autoloader::NS;
-                if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                        array($base_dir, DS, '.php'),
-                        array($namespace, Psr4Autoloader::NS, ''),
-                        $file
-                    );
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @access protected
-     * @param  string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getDirectoryFromPartialNamespace($partial_namespace)
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments then loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        // we're only interested in the first element, so pull that from the array
-        $namespace = array_shift($namespace_segments);
-        // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-        // nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
-    }
+	/**
+	 * @var array $FQCNs
+	 */
+	protected $FQCNs = array();
+
+	/**
+	 * @var array $namespaces
+	 */
+	protected $namespaces = array();
+
+
+	/**
+	 * @access protected
+	 * @param string $namespace
+	 * @param string $namespace_base_dir
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setNamespace($namespace, $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFQCNs()
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param string|array $namespaces
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($namespaces)
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @access protected
+	 * @param array $partial_namespace
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function FindFQCNsByNamespace($partial_namespace)
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		if (iterator_count($iterator) === 0) {
+			return array();
+		}
+		foreach ($iterator as $file) {
+			$file = \EEH_File::standardise_directory_separators($file);
+			foreach ($this->namespaces as $namespace => $base_dir) {
+				$namespace .= Psr4Autoloader::NS;
+				if (strpos($file, $base_dir) === 0) {
+					$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+						array($base_dir, DS, '.php'),
+						array($namespace, Psr4Autoloader::NS, ''),
+						$file
+					);
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @access protected
+	 * @param  string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getDirectoryFromPartialNamespace($partial_namespace)
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments then loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		// we're only interested in the first element, so pull that from the array
+		$namespace = array_shift($namespace_segments);
+		// check if there's a base directory registered for that namespace
+		$prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+		// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode(DS, $namespace_segments) . DS;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -36,13 +36,13 @@ 
      */
     protected function setNamespace($namespace, $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -77,12 +77,12 @@ 
      */
     public function locate($namespaces)
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -118,7 +118,7 @@ 
             foreach ($this->namespaces as $namespace => $base_dir) {
                 $namespace .= Psr4Autoloader::NS;
                 if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                    $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                         array($base_dir, DS, '.php'),
                         array($namespace, Psr4Autoloader::NS, ''),
                         $file
@@ -151,13 +151,13 @@ 
         // we're only interested in the first element, so pull that from the array
         $namespace = array_shift($namespace_segments);
         // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+        $prefix = $psr4_loader->prefixes($namespace.Psr4Autoloader::NS);
         // nope? then the incoming namespace is invalid
         if (empty($prefix) || empty($prefix[0])) {
             throw new InvalidClassException($partial_namespace);
         }
         $this->setNamespace($namespace, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
+        return $prefix[0].implode(DS, $namespace_segments).DS;
     }
 }