eventespresso / event-espresso-core

core/libraries/rest_api/changes/Changes_In_4_8_36.php

Spacing +3 added lines, -3 removed lines

@@ -122,9 +122,9 @@
                 $headers,
                 array_flip(
                     array(
-                        Base::header_prefix_for_wp . 'Total',
-                        Base::header_prefix_for_wp . 'TotalPages',
-                        Base::header_prefix_for_wp . 'PageSize',
+                        Base::header_prefix_for_wp.'Total',
+                        Base::header_prefix_for_wp.'TotalPages',
+                        Base::header_prefix_for_wp.'PageSize',
                     )));
         }
         return $headers;

Indentation +173 added lines, -173 removed lines

@@ -14,179 +14,179 @@
 class Changes_In_4_8_36 extends Changes_In_Base
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function set_hooks()
-    {
-        //set a hook to remove the "calculate" query param
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array($this, 'remove_calculate_query_param'),
-            10,
-            3
-        );
-        //don't add the _calculated_fields either
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            array($this, 'remove_calculated_fields_from_response'),
-            10,
-            5
-        );
-        //and also don't add the count headers
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'remove_headers_new_in_this_version'),
-            10,
-            3
-        );
-        //remove the old featured_image part of the response...
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            array($this, 'add_old_featured_image_part_of_cpt_entities'),
-            10,
-            5
-        );
-        //assuming ticket 9425's change gets pushed with 9406, we don't need to
-        //remove it from the calculated fields on older requests (because this will
-        //be the first version with calculated fields)
-        //before this, infinity was -1, now it's null
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            array($this, 'use_negative_one_for_infinity_before_this_version'),
-            10,
-            4
-        );
-    }
-
-
-
-    /**
-     * Dont show "calculate" as an query param option in the index
-     *
-     * @param array     $query_params
-     * @param \EEM_base $model
-     * @param string    $version
-     * @return array
-     */
-    public function remove_calculate_query_param($query_params, \EEM_Base $model, $version)
-    {
-        if ($this->applies_to_version($version)) {
-            unset($query_params['calculate']);
-        }
-        return $query_params;
-    }
-
-
-
-    /**
-     * Removes the "_calculate_fields" part of entity responses before 4.8.36
-     *
-     * @param array            $entity_response_array
-     * @param \EEM_Base        $model
-     * @param string           $request_context
-     * @param \WP_REST_Request $request
-     * @param Read             $controller
-     * @return array
-     */
-    public function remove_calculated_fields_from_response(
-        $entity_response_array,
-        \EEM_Base $model,
-        $request_context,
-        \WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->applies_to_version($controller->get_model_version_info()->requested_version())) {
-            unset($entity_response_array['_calculated_fields']);
-        }
-        return $entity_response_array;
-    }
-
-
-
-    /**
-     * Removes the new headers for requests before 4.8.36
-     *
-     * @param array  $headers
-     * @param Base   $controller
-     * @param string $version
-     * @return array
-     */
-    public function remove_headers_new_in_this_version(
-        $headers,
-        Controller_Base $controller,
-        $version
-    ) {
-        if ($this->applies_to_version($version)) {
-            $headers = array_diff_key(
-                $headers,
-                array_flip(
-                    array(
-                        Base::header_prefix_for_wp . 'Total',
-                        Base::header_prefix_for_wp . 'TotalPages',
-                        Base::header_prefix_for_wp . 'PageSize',
-                    )));
-        }
-        return $headers;
-    }
-
-
-
-    /**
-     * Puts the 'featured_image_url' back in for responses before 4.8.36.
-     *
-     * @param array            $entity_response_array
-     * @param \EEM_Base        $model
-     * @param string           $request_context
-     * @param \WP_REST_Request $request
-     * @param Read             $controller
-     * @return array
-     */
-    public function add_old_featured_image_part_of_cpt_entities(
-        $entity_response_array,
-        \EEM_Base $model,
-        $request_context,
-        \WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->applies_to_version($controller->get_model_version_info()->requested_version())
-            && $model instanceof \EEM_CPT_Base
-        ) {
-            $attachment = wp_get_attachment_image_src(
-                get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
-                'full'
-            );
-            $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
-        }
-        return $entity_response_array;
-    }
-
-
-
-    /**
-     * If the value was infinity, we now use null in our JSON responses,
-     * but before this version we used -1.
-     *
-     * @param mixed                $new_value
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_value
-     * @return mixed
-     */
-    public function use_negative_one_for_infinity_before_this_version(
-        $new_value,
-        $field_obj,
-        $original_value,
-        $requested_value
-    ) {
-        if ($this->applies_to_version($requested_value)
-            && $original_value === EE_INF
-        ) {
-            //return the old representation of infinity in the JSON
-            return -1;
-        }
-        return $new_value;
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function set_hooks()
+	{
+		//set a hook to remove the "calculate" query param
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array($this, 'remove_calculate_query_param'),
+			10,
+			3
+		);
+		//don't add the _calculated_fields either
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			array($this, 'remove_calculated_fields_from_response'),
+			10,
+			5
+		);
+		//and also don't add the count headers
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'remove_headers_new_in_this_version'),
+			10,
+			3
+		);
+		//remove the old featured_image part of the response...
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			array($this, 'add_old_featured_image_part_of_cpt_entities'),
+			10,
+			5
+		);
+		//assuming ticket 9425's change gets pushed with 9406, we don't need to
+		//remove it from the calculated fields on older requests (because this will
+		//be the first version with calculated fields)
+		//before this, infinity was -1, now it's null
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			array($this, 'use_negative_one_for_infinity_before_this_version'),
+			10,
+			4
+		);
+	}
+
+
+
+	/**
+	 * Dont show "calculate" as an query param option in the index
+	 *
+	 * @param array     $query_params
+	 * @param \EEM_base $model
+	 * @param string    $version
+	 * @return array
+	 */
+	public function remove_calculate_query_param($query_params, \EEM_Base $model, $version)
+	{
+		if ($this->applies_to_version($version)) {
+			unset($query_params['calculate']);
+		}
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Removes the "_calculate_fields" part of entity responses before 4.8.36
+	 *
+	 * @param array            $entity_response_array
+	 * @param \EEM_Base        $model
+	 * @param string           $request_context
+	 * @param \WP_REST_Request $request
+	 * @param Read             $controller
+	 * @return array
+	 */
+	public function remove_calculated_fields_from_response(
+		$entity_response_array,
+		\EEM_Base $model,
+		$request_context,
+		\WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->applies_to_version($controller->get_model_version_info()->requested_version())) {
+			unset($entity_response_array['_calculated_fields']);
+		}
+		return $entity_response_array;
+	}
+
+
+
+	/**
+	 * Removes the new headers for requests before 4.8.36
+	 *
+	 * @param array  $headers
+	 * @param Base   $controller
+	 * @param string $version
+	 * @return array
+	 */
+	public function remove_headers_new_in_this_version(
+		$headers,
+		Controller_Base $controller,
+		$version
+	) {
+		if ($this->applies_to_version($version)) {
+			$headers = array_diff_key(
+				$headers,
+				array_flip(
+					array(
+						Base::header_prefix_for_wp . 'Total',
+						Base::header_prefix_for_wp . 'TotalPages',
+						Base::header_prefix_for_wp . 'PageSize',
+					)));
+		}
+		return $headers;
+	}
+
+
+
+	/**
+	 * Puts the 'featured_image_url' back in for responses before 4.8.36.
+	 *
+	 * @param array            $entity_response_array
+	 * @param \EEM_Base        $model
+	 * @param string           $request_context
+	 * @param \WP_REST_Request $request
+	 * @param Read             $controller
+	 * @return array
+	 */
+	public function add_old_featured_image_part_of_cpt_entities(
+		$entity_response_array,
+		\EEM_Base $model,
+		$request_context,
+		\WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->applies_to_version($controller->get_model_version_info()->requested_version())
+			&& $model instanceof \EEM_CPT_Base
+		) {
+			$attachment = wp_get_attachment_image_src(
+				get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
+				'full'
+			);
+			$entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
+		}
+		return $entity_response_array;
+	}
+
+
+
+	/**
+	 * If the value was infinity, we now use null in our JSON responses,
+	 * but before this version we used -1.
+	 *
+	 * @param mixed                $new_value
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_value
+	 * @return mixed
+	 */
+	public function use_negative_one_for_infinity_before_this_version(
+		$new_value,
+		$field_obj,
+		$original_value,
+		$requested_value
+	) {
+		if ($this->applies_to_version($requested_value)
+			&& $original_value === EE_INF
+		) {
+			//return the old representation of infinity in the JSON
+			return -1;
+		}
+		return $new_value;
+	}
 
 }
 

core/libraries/rest_api/Rest_Exception.php

Indentation +33 added lines, -33 removed lines

@@ -12,7 +12,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,46 +20,46 @@ 
 class Rest_Exception extends \EE_Error
 {
 
-    /**
-     * @var array
-     */
-    protected $_wp_error_data = array();
+	/**
+	 * @var array
+	 */
+	protected $_wp_error_data = array();
 
-    protected $_wp_error_code = '';
+	protected $_wp_error_code = '';
 
 
 
-    public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
-    {
-        parent::__construct(
-            $message,
-            500,
-            $previous);
-        $this->_wp_error_data = $wp_error_data;
-        $this->_wp_error_code = $string_code;
-    }
+	public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
+	{
+		parent::__construct(
+			$message,
+			500,
+			$previous);
+		$this->_wp_error_data = $wp_error_data;
+		$this->_wp_error_code = $string_code;
+	}
 
 
 
-    /**
-     * Array of data that may have been set during the constructor, intended for WP_Error's data
-     *
-     * @return array
-     */
-    public function get_data()
-    {
-        return $this->_wp_error_data;
-    }
+	/**
+	 * Array of data that may have been set during the constructor, intended for WP_Error's data
+	 *
+	 * @return array
+	 */
+	public function get_data()
+	{
+		return $this->_wp_error_data;
+	}
 
 
 
-    /**
-     * Gets the error string
-     *
-     * @return string
-     */
-    public function get_string_code()
-    {
-        return $this->_wp_error_code;
-    }
+	/**
+	 * Gets the error string
+	 *
+	 * @return string
+	 */
+	public function get_string_code()
+	{
+		return $this->_wp_error_code;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

core/libraries/rest_api/calculations/Datetime.php

Indentation +116 added lines, -116 removed lines

@@ -14,7 +14,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,128 +22,128 @@ 
 class Datetime extends Calculations_Base
 {
 
-    /**
-     * Calculates the total spaces available on the datetime, taking into account
-     * ticket limits too.
-     *
-     * @see EE_Datetime::spaces_remaining( true )
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function spaces_remaining_considering_tickets($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
-            $dtt_obj = \EEM_Datetime::instance()->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
-        } else {
-            $dtt_obj = null;
-        }
-        if ($dtt_obj instanceof \EE_Datetime) {
-            return $dtt_obj->spaces_remaining(true);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Datetime.DTT_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
+	/**
+	 * Calculates the total spaces available on the datetime, taking into account
+	 * ticket limits too.
+	 *
+	 * @see EE_Datetime::spaces_remaining( true )
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function spaces_remaining_considering_tickets($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
+			$dtt_obj = \EEM_Datetime::instance()->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
+		} else {
+			$dtt_obj = null;
+		}
+		if ($dtt_obj instanceof \EE_Datetime) {
+			return $dtt_obj->spaces_remaining(true);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Datetime.DTT_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
 
 
 
-    /**
-     * Counts registrations who have checked into this datetime
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_in_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
-        return \EEM_Registration::instance()
-                                ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
-    }
+	/**
+	 * Counts registrations who have checked into this datetime
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_in_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
+		return \EEM_Registration::instance()
+								->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
+	}
 
 
 
-    /**
-     * Counts registrations who have checked out of this datetime
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_out_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
-        return \EEM_Registration::instance()
-                                ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
-    }
+	/**
+	 * Counts registrations who have checked out of this datetime
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_out_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
+		return \EEM_Registration::instance()
+								->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
+	}
 
 
 
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
-        return \EEM_Registration::instance()->count(
-            array(
-                array(
-                    'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
-                    'STS_ID'                 => \EEM_Registration::status_id_pending_payment,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
+		return \EEM_Registration::instance()->count(
+			array(
+				array(
+					'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
+					'STS_ID'                 => \EEM_Registration::status_id_pending_payment,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -13,7 +13,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -68,7 +68,7 @@ 
      */
     public static function registrations_checked_in_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
@@ -96,7 +96,7 @@ 
      */
     public static function registrations_checked_out_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
@@ -125,7 +125,7 @@ 
      */
     public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',

core/libraries/rest_api/calculations/Base.php

Indentation +34 added lines, -34 removed lines

@@ -13,7 +13,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,37 +21,37 @@ 
 class Base
 {
 
-    /**
-     * @param $required_permission
-     * @param $attempted_calculation
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    protected static function _verify_current_user_can($required_permission, $attempted_calculation)
-    {
-        if (! current_user_can($required_permission)) {
-            throw new Rest_Exception(
-                'permission_denied',
-                sprintf(
-                    __('Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
-                        'event_espresso'),
-                    $attempted_calculation,
-                    \EEH_Inflector::pluralize_and_lower(self::get_resource_name()),
-                    $required_permission
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Gets the name of the resource of the called class
-     *
-     * @return string
-     */
-    public static function get_resource_name()
-    {
-        $classname = get_called_class();
-        return substr($classname, strrpos($classname, '\\') + 1);
-    }
+	/**
+	 * @param $required_permission
+	 * @param $attempted_calculation
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	protected static function _verify_current_user_can($required_permission, $attempted_calculation)
+	{
+		if (! current_user_can($required_permission)) {
+			throw new Rest_Exception(
+				'permission_denied',
+				sprintf(
+					__('Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
+						'event_espresso'),
+					$attempted_calculation,
+					\EEH_Inflector::pluralize_and_lower(self::get_resource_name()),
+					$required_permission
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Gets the name of the resource of the called class
+	 *
+	 * @return string
+	 */
+	public static function get_resource_name()
+	{
+		$classname = get_called_class();
+		return substr($classname, strrpos($classname, '\\') + 1);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -28,7 +28,7 @@ 
      */
     protected static function _verify_current_user_can($required_permission, $attempted_calculation)
     {
-        if (! current_user_can($required_permission)) {
+        if ( ! current_user_can($required_permission)) {
             throw new Rest_Exception(
                 'permission_denied',
                 sprintf(

core/libraries/rest_api/calculations/Registration.php

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -37,7 +37,7 @@ 
         } else {
             $reg = null;
         }
-        if (! $reg instanceof \EE_Registration
+        if ( ! $reg instanceof \EE_Registration
         ) {
             throw new \EE_Error(
                 sprintf(

Indentation +55 added lines, -55 removed lines

@@ -13,7 +13,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,58 +21,58 @@ 
 class Registration extends Calculations_Base
 {
 
-    /**
-     * Calculates the checkin status for each datetime this registration has access to
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function datetime_checkin_stati($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
-            $reg = \EEM_Registration::instance()->get_one_by_ID($wpdb_row['Registration.REG_ID']);
-        } else {
-            $reg = null;
-        }
-        if (! $reg instanceof \EE_Registration
-        ) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Registration.REG_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $datetime_ids = \EEM_Datetime::instance()->get_col(
-            array(
-                array(
-                    'Ticket.TKT_ID' => $reg->ticket_ID(),
-                ),
-                'default_where_conditions' => \EEM_Base::default_where_conditions_minimum_all
-            )
-        );
-        $checkin_stati = array();
-        foreach ($datetime_ids as $datetime_id) {
-            $status = $reg->check_in_status_for_datetime($datetime_id);
-            switch ($status) {
-                case \EE_Registration::checkin_status_out:
-                    $status_pretty = 'OUT';
-                    break;
-                case \EE_Registration::checkin_status_in:
-                    $status_pretty = 'IN';
-                    break;
-                case \EE_Registration::checkin_status_never:
-                default:
-                    $status_pretty = 'NEVER';
-                    break;
-            }
-            $checkin_stati[$datetime_id] = $status_pretty;
-        }
-        return $checkin_stati;
-    }
+	/**
+	 * Calculates the checkin status for each datetime this registration has access to
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function datetime_checkin_stati($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
+			$reg = \EEM_Registration::instance()->get_one_by_ID($wpdb_row['Registration.REG_ID']);
+		} else {
+			$reg = null;
+		}
+		if (! $reg instanceof \EE_Registration
+		) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Registration.REG_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$datetime_ids = \EEM_Datetime::instance()->get_col(
+			array(
+				array(
+					'Ticket.TKT_ID' => $reg->ticket_ID(),
+				),
+				'default_where_conditions' => \EEM_Base::default_where_conditions_minimum_all
+			)
+		);
+		$checkin_stati = array();
+		foreach ($datetime_ids as $datetime_id) {
+			$status = $reg->check_in_status_for_datetime($datetime_id);
+			switch ($status) {
+				case \EE_Registration::checkin_status_out:
+					$status_pretty = 'OUT';
+					break;
+				case \EE_Registration::checkin_status_in:
+					$status_pretty = 'IN';
+					break;
+				case \EE_Registration::checkin_status_never:
+				default:
+					$status_pretty = 'NEVER';
+					break;
+			}
+			$checkin_stati[$datetime_id] = $status_pretty;
+		}
+		return $checkin_stati;
+	}
 }

core/libraries/rest_api/calculations/Event.php

Indentation +347 added lines, -347 removed lines

@@ -14,7 +14,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,350 +22,350 @@ 
 class Event extends Calculations_Base
 {
 
-    /**
-     * Calculates the total spaces on the event (not subtracting sales, but taking
-     * sales into account; so this is the optimum sales that CAN still be achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function optimum_sales_at_start($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
-            $event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        } else {
-            $event_obj = null;
-        }
-        if ($event_obj instanceof \EE_Event) {
-            return $event_obj->total_available_spaces(true);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Event_CPT.ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
-     * sales that COULD have been achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function optimum_sales_now($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
-            $event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        } else {
-            $event_obj = null;
-        }
-        if ($event_obj instanceof \EE_Event) {
-            return $event_obj->total_available_spaces(false);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Event_CPT.ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Like optimum_sales_now, but minus total sales so far.
-     * See EE_Event::spaces_remaining_for_sale( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function spaces_remaining($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
-            $event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        } else {
-            $event_obj = null;
-        }
-        if ($event_obj instanceof \EE_Event) {
-            return $event_obj->spaces_remaining_for_sale();
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Event_CPT.ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Counts the number of approved registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function spots_taken($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        return \EEM_Registration::instance()->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => \EEM_Registration::status_id_approved,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
-        return \EEM_Registration::instance()->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => \EEM_Registration::status_id_pending_payment,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-
-    /**
-     * Counts all the registrations who have checked into one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int|null if permission denied
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_in_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
-        return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
-    }
-
-
-
-    /**
-     * Counts all the registrations who have checked out of one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_out_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
-        return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
-    }
-
-
-
-    /**
-     * Gets the thumbnail image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_thumbnail($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'thumbnail');
-    }
-
-
-
-    /**
-     * Gets the medium image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_medium($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium');
-    }
-
-
-
-    /**
-     * Gets the medium-large image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_medium_large($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium_large');
-    }
-
-
-
-    /**
-     * Gets the large image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_large($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'large');
-    }
-
-
-
-    /**
-     * Gets the post-thumbnail image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_post_thumbnail($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'post-thumbnail');
-    }
-
-
-
-    /**
-     * Gets the full size image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_full($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'full');
-    }
-
-
-
-    /**
-     * Gets image specs and formats them for the display in the API,
-     * according to the image size requested
-     *
-     * @param int    $EVT_ID
-     * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
-     * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
-     */
-    protected static function _calculate_image_data($EVT_ID, $image_size)
-    {
-        $attachment_id = get_post_thumbnail_id($EVT_ID);
-        $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
-            return null;
-        }
-        if (isset($data[3])) {
-            $generated = $data[3];
-        } else {
-            $generated = true;
-        }
-        return array(
-            'url'       => $data[0],
-            'width'     => $data[1],
-            'height'    => $data[2],
-            'generated' => $generated,
-        );
-    }
+	/**
+	 * Calculates the total spaces on the event (not subtracting sales, but taking
+	 * sales into account; so this is the optimum sales that CAN still be achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function optimum_sales_at_start($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
+			$event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		} else {
+			$event_obj = null;
+		}
+		if ($event_obj instanceof \EE_Event) {
+			return $event_obj->total_available_spaces(true);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Event_CPT.ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
+	 * sales that COULD have been achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function optimum_sales_now($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
+			$event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		} else {
+			$event_obj = null;
+		}
+		if ($event_obj instanceof \EE_Event) {
+			return $event_obj->total_available_spaces(false);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Event_CPT.ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Like optimum_sales_now, but minus total sales so far.
+	 * See EE_Event::spaces_remaining_for_sale( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function spaces_remaining($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
+			$event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		} else {
+			$event_obj = null;
+		}
+		if ($event_obj instanceof \EE_Event) {
+			return $event_obj->spaces_remaining_for_sale();
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Event_CPT.ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Counts the number of approved registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function spots_taken($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		return \EEM_Registration::instance()->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => \EEM_Registration::status_id_approved,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
+		return \EEM_Registration::instance()->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => \EEM_Registration::status_id_pending_payment,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+
+	/**
+	 * Counts all the registrations who have checked into one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int|null if permission denied
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_in_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
+		return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
+	}
+
+
+
+	/**
+	 * Counts all the registrations who have checked out of one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_out_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
+		return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
+	}
+
+
+
+	/**
+	 * Gets the thumbnail image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_thumbnail($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'thumbnail');
+	}
+
+
+
+	/**
+	 * Gets the medium image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_medium($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium');
+	}
+
+
+
+	/**
+	 * Gets the medium-large image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_medium_large($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium_large');
+	}
+
+
+
+	/**
+	 * Gets the large image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_large($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'large');
+	}
+
+
+
+	/**
+	 * Gets the post-thumbnail image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_post_thumbnail($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'post-thumbnail');
+	}
+
+
+
+	/**
+	 * Gets the full size image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_full($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'full');
+	}
+
+
+
+	/**
+	 * Gets image specs and formats them for the display in the API,
+	 * according to the image size requested
+	 *
+	 * @param int    $EVT_ID
+	 * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
+	 * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
+	 */
+	protected static function _calculate_image_data($EVT_ID, $image_size)
+	{
+		$attachment_id = get_post_thumbnail_id($EVT_ID);
+		$data = wp_get_attachment_image_src($attachment_id, $image_size);
+		if (! $data) {
+			return null;
+		}
+		if (isset($data[3])) {
+			$generated = $data[3];
+		} else {
+			$generated = true;
+		}
+		return array(
+			'url'       => $data[0],
+			'width'     => $data[1],
+			'height'    => $data[2],
+			'generated' => $generated,
+		);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -13,7 +13,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -135,7 +135,7 @@ 
      */
     public static function spots_taken($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -171,7 +171,7 @@ 
      */
     public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -208,7 +208,7 @@ 
      */
     public static function registrations_checked_in_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -236,7 +236,7 @@ 
      */
     public static function registrations_checked_out_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -353,7 +353,7 @@ 
     {
         $attachment_id = get_post_thumbnail_id($EVT_ID);
         $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
+        if ( ! $data) {
             return null;
         }
         if (isset($data[3])) {

core/libraries/rest_api/Calculated_Model_Fields.php

Indentation +124 added lines, -124 removed lines

@@ -15,7 +15,7 @@ 
  * @since                 4.8.35.rc.001
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -23,127 +23,127 @@ 
 class Calculated_Model_Fields
 {
 
-    /**
-     * @var array
-     */
-    protected $_mapping;
-
-
-
-    /**
-     * @param bool $refresh
-     * @return array top-level-keys are model names (eg "Event")
-     * next-level are the calculated field names AND method names on classes
-     * which perform calculations, values are the fully qualified classnames which do the calculationss
-     * These callbacks should accept as arguments:
-     * the wpdb row results,
-     * the WP_Request object,
-     * the controller object
-     */
-    public function mapping($refresh = false)
-    {
-        if (! $this->_mapping || $refresh) {
-            $this->_mapping = $this->_generate_new_mapping();
-        }
-        return $this->_mapping;
-    }
-
-
-
-    /**
-     * Generates  anew mapping between model calculated fields and their callbacks
-     *
-     * @return array
-     */
-    protected function _generate_new_mapping()
-    {
-        $rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\';
-        $event_calculations_class = $rest_api_calculations_namespace . 'Event';
-        $datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime';
-        $registration_class = $rest_api_calculations_namespace . 'Registration';
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
-            array(
-                'Event'        => array(
-                    'optimum_sales_at_start'          => $event_calculations_class,
-                    'optimum_sales_now'               => $event_calculations_class,
-                    'spots_taken'                     => $event_calculations_class,
-                    'spots_taken_pending_payment'     => $event_calculations_class,
-                    'spaces_remaining'                => $event_calculations_class,
-                    'registrations_checked_in_count'  => $event_calculations_class,
-                    'registrations_checked_out_count' => $event_calculations_class,
-                    'image_thumbnail'                 => $event_calculations_class,
-                    'image_medium'                    => $event_calculations_class,
-                    'image_medium_large'              => $event_calculations_class,
-                    'image_large'                     => $event_calculations_class,
-                    'image_post_thumbnail'            => $event_calculations_class,
-                    'image_full'                      => $event_calculations_class,
-                ),
-                'Datetime'     => array(
-                    'spaces_remaining_considering_tickets' => $datetime_calculations_class,
-                    'registrations_checked_in_count'       => $datetime_calculations_class,
-                    'registrations_checked_out_count'      => $datetime_calculations_class,
-                    'spots_taken_pending_payment'          => $datetime_calculations_class,
-                ),
-                'Registration' => array(
-                    'datetime_checkin_stati' => $registration_class,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the known calculated fields for model
-     *
-     * @param \EEM_Base $model
-     * @return array allowable values for this field
-     */
-    public function retrieve_calculated_fields_for_model(\EEM_Base $model)
-    {
-        $mapping = $this->mapping();
-        if (isset($mapping[$model->get_this_model_name()])) {
-            return array_keys($mapping[$model->get_this_model_name()]);
-        } else {
-            return array();
-        }
-    }
-
-
-
-    /**
-     * Retrieves the value for this calculation
-     *
-     * @param \EEM_Base                                               type $model
-     * @param string                                                  $field_name
-     * @param array                                                   $wpdb_row
-     * @param \WP_REST_Request
-     * @param \EventEspresso\core\libraries\rest_api\controllers\Base $controller
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    public function retrieve_calculated_field_value(
-        \EEM_Base $model,
-        $field_name,
-        $wpdb_row,
-        $rest_request,
-        Base $controller
-    ) {
-        $mapping = $this->mapping();
-        if (isset($mapping[$model->get_this_model_name()])
-            && isset($mapping[$model->get_this_model_name()][$field_name])
-        ) {
-            $classname = $mapping[$model->get_this_model_name()][$field_name];
-            return call_user_func(array($classname, $field_name), $wpdb_row, $rest_request, $controller);
-        }
-        throw new Rest_Exception(
-            'calculated_field_does_not_exist',
-            sprintf(
-                __('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
-                $field_name,
-                $model->get_this_model_name()
-            )
-        );
-    }
+	/**
+	 * @var array
+	 */
+	protected $_mapping;
+
+
+
+	/**
+	 * @param bool $refresh
+	 * @return array top-level-keys are model names (eg "Event")
+	 * next-level are the calculated field names AND method names on classes
+	 * which perform calculations, values are the fully qualified classnames which do the calculationss
+	 * These callbacks should accept as arguments:
+	 * the wpdb row results,
+	 * the WP_Request object,
+	 * the controller object
+	 */
+	public function mapping($refresh = false)
+	{
+		if (! $this->_mapping || $refresh) {
+			$this->_mapping = $this->_generate_new_mapping();
+		}
+		return $this->_mapping;
+	}
+
+
+
+	/**
+	 * Generates  anew mapping between model calculated fields and their callbacks
+	 *
+	 * @return array
+	 */
+	protected function _generate_new_mapping()
+	{
+		$rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\';
+		$event_calculations_class = $rest_api_calculations_namespace . 'Event';
+		$datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime';
+		$registration_class = $rest_api_calculations_namespace . 'Registration';
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
+			array(
+				'Event'        => array(
+					'optimum_sales_at_start'          => $event_calculations_class,
+					'optimum_sales_now'               => $event_calculations_class,
+					'spots_taken'                     => $event_calculations_class,
+					'spots_taken_pending_payment'     => $event_calculations_class,
+					'spaces_remaining'                => $event_calculations_class,
+					'registrations_checked_in_count'  => $event_calculations_class,
+					'registrations_checked_out_count' => $event_calculations_class,
+					'image_thumbnail'                 => $event_calculations_class,
+					'image_medium'                    => $event_calculations_class,
+					'image_medium_large'              => $event_calculations_class,
+					'image_large'                     => $event_calculations_class,
+					'image_post_thumbnail'            => $event_calculations_class,
+					'image_full'                      => $event_calculations_class,
+				),
+				'Datetime'     => array(
+					'spaces_remaining_considering_tickets' => $datetime_calculations_class,
+					'registrations_checked_in_count'       => $datetime_calculations_class,
+					'registrations_checked_out_count'      => $datetime_calculations_class,
+					'spots_taken_pending_payment'          => $datetime_calculations_class,
+				),
+				'Registration' => array(
+					'datetime_checkin_stati' => $registration_class,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the known calculated fields for model
+	 *
+	 * @param \EEM_Base $model
+	 * @return array allowable values for this field
+	 */
+	public function retrieve_calculated_fields_for_model(\EEM_Base $model)
+	{
+		$mapping = $this->mapping();
+		if (isset($mapping[$model->get_this_model_name()])) {
+			return array_keys($mapping[$model->get_this_model_name()]);
+		} else {
+			return array();
+		}
+	}
+
+
+
+	/**
+	 * Retrieves the value for this calculation
+	 *
+	 * @param \EEM_Base                                               type $model
+	 * @param string                                                  $field_name
+	 * @param array                                                   $wpdb_row
+	 * @param \WP_REST_Request
+	 * @param \EventEspresso\core\libraries\rest_api\controllers\Base $controller
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	public function retrieve_calculated_field_value(
+		\EEM_Base $model,
+		$field_name,
+		$wpdb_row,
+		$rest_request,
+		Base $controller
+	) {
+		$mapping = $this->mapping();
+		if (isset($mapping[$model->get_this_model_name()])
+			&& isset($mapping[$model->get_this_model_name()][$field_name])
+		) {
+			$classname = $mapping[$model->get_this_model_name()][$field_name];
+			return call_user_func(array($classname, $field_name), $wpdb_row, $rest_request, $controller);
+		}
+		throw new Rest_Exception(
+			'calculated_field_does_not_exist',
+			sprintf(
+				__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
+				$field_name,
+				$model->get_this_model_name()
+			)
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -14,7 +14,7 @@ 
  * @author                Mike Nelson
  * @since                 4.8.35.rc.001
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -42,7 +42,7 @@ 
      */
     public function mapping($refresh = false)
     {
-        if (! $this->_mapping || $refresh) {
+        if ( ! $this->_mapping || $refresh) {
             $this->_mapping = $this->_generate_new_mapping();
         }
         return $this->_mapping;
@@ -58,9 +58,9 @@ 
     protected function _generate_new_mapping()
     {
         $rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\';
-        $event_calculations_class = $rest_api_calculations_namespace . 'Event';
-        $datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime';
-        $registration_class = $rest_api_calculations_namespace . 'Registration';
+        $event_calculations_class = $rest_api_calculations_namespace.'Event';
+        $datetime_calculations_class = $rest_api_calculations_namespace.'Datetime';
+        $registration_class = $rest_api_calculations_namespace.'Registration';
         return apply_filters(
             'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
             array(

core/libraries/rest_api/Capabilities.php

Indentation +120 added lines, -120 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -17,134 +17,134 @@ 
 class Capabilities
 {
 
-    /**
-     * The current user can see at least SOME of these entities.
-     *
-     * @param \EEM_Base $model
-     * @param string    $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return boolean
-     */
-    public static function current_user_has_partial_access_to($model, $model_context = \EEM_Base::caps_read)
-    {
-        if (
-        apply_filters(
-            'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
-            false,
-            $model,
-            $model
-        )
-        ) {
-            return true;
-        }
-        foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
-            if ($restriction_obj instanceof \EE_Return_None_Where_Conditions) {
-                return false;
-            }
-        }
-        if (
-        apply_filters(
-            'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
-            false,
-            $model,
-            $model
-        )
-        ) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * The current user can see at least SOME of these entities.
+	 *
+	 * @param \EEM_Base $model
+	 * @param string    $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return boolean
+	 */
+	public static function current_user_has_partial_access_to($model, $model_context = \EEM_Base::caps_read)
+	{
+		if (
+		apply_filters(
+			'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
+			false,
+			$model,
+			$model
+		)
+		) {
+			return true;
+		}
+		foreach ($model->caps_missing($model_context) as $capability_name => $restriction_obj) {
+			if ($restriction_obj instanceof \EE_Return_None_Where_Conditions) {
+				return false;
+			}
+		}
+		if (
+		apply_filters(
+			'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
+			false,
+			$model,
+			$model
+		)
+		) {
+			return false;
+		}
+		return true;
+	}
 
 
 
-    /**
-     * Gets an array of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param \EEM_Base $model
-     * @param string    $request_type one of the constants on WP_JSON_Server
-     * @return array
-     */
-    public static function get_missing_permissions($model, $request_type = \EEM_Base::caps_read)
-    {
-        return $model->caps_missing($request_type);
-    }
+	/**
+	 * Gets an array of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param \EEM_Base $model
+	 * @param string    $request_type one of the constants on WP_JSON_Server
+	 * @return array
+	 */
+	public static function get_missing_permissions($model, $request_type = \EEM_Base::caps_read)
+	{
+		return $model->caps_missing($request_type);
+	}
 
 
 
-    /**
-     * Gets a string of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param \EEM_Base $model
-     * @param string    $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return string
-     */
-    public static function get_missing_permissions_string($model, $model_context = \EEM_Base::caps_read)
-    {
-        return implode(',', array_keys(self::get_missing_permissions($model, $model_context)));
-    }
+	/**
+	 * Gets a string of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param \EEM_Base $model
+	 * @param string    $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return string
+	 */
+	public static function get_missing_permissions_string($model, $model_context = \EEM_Base::caps_read)
+	{
+		return implode(',', array_keys(self::get_missing_permissions($model, $model_context)));
+	}
 
 
 
-    /**
-     * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
-     *
-     * @param array              $entity
-     * @param \EEM_Base          $model
-     * @param string             $request_type       one of the return values from EEM_Base::valid_cap_contexts()
-     * @param Model_Version_Info $model_version_info
-     * @param string             $primary_key_string result of EEM_Base::get_index_primary_key_string(), so that we can
-     *                                               use this with models that have no primary key
-     * @return array ready for converting into json
-     */
-    public static function filter_out_inaccessible_entity_fields(
-        $entity,
-        $model,
-        $request_type,
-        $model_version_info,
-        $primary_key_string = null
-    ) {
-        //if they didn't provide the primary key string, we'll just hope we can figure it out
-        //from the entity (although it's preferred client code does it, because the entity might be missing
-        //necessary fields for creating the primary key string, or they could be named differently)
-        if ($primary_key_string === null) {
-            $primary_key_string = $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($entity)
-            );
-        }
-        //we only care to do this for frontend reads and when the user can't edit the item
-        if (
-            $request_type !== \EEM_Base::caps_read
-            || $model->exists(
-                $model->alter_query_params_to_restrict_by_ID(
-                    $primary_key_string,
-                    array(
-                        'default_where_conditions' => 'none',
-                        'caps'                     => \EEM_Base::caps_edit,
-                    )
-                )
-            )
-        ) {
-            return $entity;
-        }
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $model_version_info->field_has_rendered_format($field_obj)
-                && isset($entity[$field_name])
-                && is_array($entity[$field_name])
-                && isset($entity[$field_name]['raw'])
-            ) {
-                unset($entity[$field_name]['raw']);
-            }
-        }
-        //theoretically we may want to filter out specific fields for specific models
-        return apply_filters(
-            'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
-            $entity,
-            $model,
-            $request_type
-        );
-    }
+	/**
+	 * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
+	 *
+	 * @param array              $entity
+	 * @param \EEM_Base          $model
+	 * @param string             $request_type       one of the return values from EEM_Base::valid_cap_contexts()
+	 * @param Model_Version_Info $model_version_info
+	 * @param string             $primary_key_string result of EEM_Base::get_index_primary_key_string(), so that we can
+	 *                                               use this with models that have no primary key
+	 * @return array ready for converting into json
+	 */
+	public static function filter_out_inaccessible_entity_fields(
+		$entity,
+		$model,
+		$request_type,
+		$model_version_info,
+		$primary_key_string = null
+	) {
+		//if they didn't provide the primary key string, we'll just hope we can figure it out
+		//from the entity (although it's preferred client code does it, because the entity might be missing
+		//necessary fields for creating the primary key string, or they could be named differently)
+		if ($primary_key_string === null) {
+			$primary_key_string = $model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($entity)
+			);
+		}
+		//we only care to do this for frontend reads and when the user can't edit the item
+		if (
+			$request_type !== \EEM_Base::caps_read
+			|| $model->exists(
+				$model->alter_query_params_to_restrict_by_ID(
+					$primary_key_string,
+					array(
+						'default_where_conditions' => 'none',
+						'caps'                     => \EEM_Base::caps_edit,
+					)
+				)
+			)
+		) {
+			return $entity;
+		}
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$model_version_info->field_has_rendered_format($field_obj)
+				&& isset($entity[$field_name])
+				&& is_array($entity[$field_name])
+				&& isset($entity[$field_name]['raw'])
+			) {
+				unset($entity[$field_name]['raw']);
+			}
+		}
+		//theoretically we may want to filter out specific fields for specific models
+		return apply_filters(
+			'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
+			$entity,
+			$model,
+			$request_type
+		);
+	}
 }
 
 // End of file Capabilities.php
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -1,7 +1,7 @@
 <?php
 namespace EventEspresso\core\libraries\rest_api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

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

Indentation +109 added lines, -109 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\libraries\rest_api\Model_Data_Translator;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,123 +21,123 @@ 
 {
 
 
-    /**
-     * @param \WP_REST_Request $request
-     * @return array|\WP_REST_Response
-     */
-    public static function handle_request_models_meta(\WP_REST_Request $request)
-    {
-        $controller = new Meta();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . 'resources~',
-                array('version'));
-            if ($matches instanceof \WP_REST_Response) {
-                return $matches;
-            }
-            $controller->set_requested_version($matches['version']);
-            return $controller->send_response($controller->_get_models_metadata_entity());
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
+	/**
+	 * @param \WP_REST_Request $request
+	 * @return array|\WP_REST_Response
+	 */
+	public static function handle_request_models_meta(\WP_REST_Request $request)
+	{
+		$controller = new Meta();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . 'resources~',
+				array('version'));
+			if ($matches instanceof \WP_REST_Response) {
+				return $matches;
+			}
+			$controller->set_requested_version($matches['version']);
+			return $controller->send_response($controller->_get_models_metadata_entity());
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
 
 
 
-    /*
+	/*
      * Gets the model metadata resource entity
      * @return array for JSON response, describing all the models available in teh requested version
      */
-    protected function _get_models_metadata_entity()
-    {
-        $response = array();
-        foreach ($this->get_model_version_info()->models_for_requested_version() as $model_name => $model_classname) {
-            $model = $this->get_model_version_info()->load_model($model_name);
-            $fields_json = array();
-            foreach (
-                $this->get_model_version_info()->fields_on_model_in_this_version($model) as $field_name =>
-                $field_obj
-            ) {
-                if ($this->get_model_version_info()->field_is_ignored($field_obj)) {
-                    continue;
-                }
-                if ($field_obj instanceof \EE_Boolean_Field) {
-                    $datatype = 'Boolean';
-                } elseif ($field_obj->get_wpdb_data_type() == '%d') {
-                    $datatype = 'Number';
-                } elseif ($field_name instanceof \EE_Serialized_Text_Field) {
-                    $datatype = 'Object';
-                } else {
-                    $datatype = 'String';
-                }
-                $default_value = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $this->get_model_version_info()->requested_version()
-                );
-                $field_json = array(
-                    'name'                => $field_name,
-                    'nicename'            => $field_obj->get_nicename(),
-                    'has_rendered_format' => $this->get_model_version_info()->field_has_rendered_format($field_obj),
-                    'has_pretty_format'   => $this->get_model_version_info()->field_has_pretty_format($field_obj),
-                    'type'                => str_replace('EE_', '', get_class($field_obj)),
-                    'datatype'            => $datatype,
-                    'nullable'            => $field_obj->is_nullable(),
-                    'default'             => $default_value,
-                    'table_alias'         => $field_obj->get_table_alias(),
-                    'table_column'        => $field_obj->get_table_column(),
-                );
-                $fields_json[$field_json['name']] = $field_json;
-            }
-            $fields_json = array_merge($fields_json,
-                $this->get_model_version_info()->extra_resource_properties_for_model($model));
-            $response[$model_name]['fields'] = apply_filters('FHEE__Meta__handle_request_models_meta__fields',
-                $fields_json, $model);
-            $relations_json = array();
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-                $relation_json = array(
-                    'name'   => $relation_name,
-                    'type'   => str_replace('EE_', '', get_class($relation_obj)),
-                    'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
-                );
-                $relations_json[$relation_name] = $relation_json;
-            }
-            $response[$model_name]['relations'] = apply_filters('FHEE__Meta__handle_request_models_meta__relations',
-                $relations_json, $model);
-        }
-        return $response;
-    }
+	protected function _get_models_metadata_entity()
+	{
+		$response = array();
+		foreach ($this->get_model_version_info()->models_for_requested_version() as $model_name => $model_classname) {
+			$model = $this->get_model_version_info()->load_model($model_name);
+			$fields_json = array();
+			foreach (
+				$this->get_model_version_info()->fields_on_model_in_this_version($model) as $field_name =>
+				$field_obj
+			) {
+				if ($this->get_model_version_info()->field_is_ignored($field_obj)) {
+					continue;
+				}
+				if ($field_obj instanceof \EE_Boolean_Field) {
+					$datatype = 'Boolean';
+				} elseif ($field_obj->get_wpdb_data_type() == '%d') {
+					$datatype = 'Number';
+				} elseif ($field_name instanceof \EE_Serialized_Text_Field) {
+					$datatype = 'Object';
+				} else {
+					$datatype = 'String';
+				}
+				$default_value = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$this->get_model_version_info()->requested_version()
+				);
+				$field_json = array(
+					'name'                => $field_name,
+					'nicename'            => $field_obj->get_nicename(),
+					'has_rendered_format' => $this->get_model_version_info()->field_has_rendered_format($field_obj),
+					'has_pretty_format'   => $this->get_model_version_info()->field_has_pretty_format($field_obj),
+					'type'                => str_replace('EE_', '', get_class($field_obj)),
+					'datatype'            => $datatype,
+					'nullable'            => $field_obj->is_nullable(),
+					'default'             => $default_value,
+					'table_alias'         => $field_obj->get_table_alias(),
+					'table_column'        => $field_obj->get_table_column(),
+				);
+				$fields_json[$field_json['name']] = $field_json;
+			}
+			$fields_json = array_merge($fields_json,
+				$this->get_model_version_info()->extra_resource_properties_for_model($model));
+			$response[$model_name]['fields'] = apply_filters('FHEE__Meta__handle_request_models_meta__fields',
+				$fields_json, $model);
+			$relations_json = array();
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+				$relation_json = array(
+					'name'   => $relation_name,
+					'type'   => str_replace('EE_', '', get_class($relation_obj)),
+					'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
+				);
+				$relations_json[$relation_name] = $relation_json;
+			}
+			$response[$model_name]['relations'] = apply_filters('FHEE__Meta__handle_request_models_meta__relations',
+				$relations_json, $model);
+		}
+		return $response;
+	}
 
 
 
-    /**
-     * Adds EE metadata to the index
-     *
-     * @param \WP_REST_Response $rest_response_obj
-     * @return \WP_REST_Response
-     */
-    public static function filter_ee_metadata_into_index(\WP_REST_Response $rest_response_obj)
-    {
-        $response_data = $rest_response_obj->get_data();
-        $addons = array();
-        foreach (\EE_Registry::instance()->addons as $addon) {
-            $addon_json = array(
-                'name'    => $addon->name(),
-                'version' => $addon->version(),
-            );
-            $addons[$addon_json['name']] = $addon_json;
-        }
-        $response_data['ee'] = array(
-            'version'              => \EEM_System_Status::instance()->get_ee_version(),
-            'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
-            'addons'               => $addons,
-            'maintenance_mode'     => \EE_Maintenance_Mode::instance()->real_level(),
-            'served_core_versions' => array_keys(\EED_Core_Rest_Api::versions_served()),
-        );
-        $rest_response_obj->set_data($response_data);
-        return $rest_response_obj;
-    }
+	/**
+	 * Adds EE metadata to the index
+	 *
+	 * @param \WP_REST_Response $rest_response_obj
+	 * @return \WP_REST_Response
+	 */
+	public static function filter_ee_metadata_into_index(\WP_REST_Response $rest_response_obj)
+	{
+		$response_data = $rest_response_obj->get_data();
+		$addons = array();
+		foreach (\EE_Registry::instance()->addons as $addon) {
+			$addon_json = array(
+				'name'    => $addon->name(),
+				'version' => $addon->version(),
+			);
+			$addons[$addon_json['name']] = $addon_json;
+		}
+		$response_data['ee'] = array(
+			'version'              => \EEM_System_Status::instance()->get_ee_version(),
+			'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
+			'addons'               => $addons,
+			'maintenance_mode'     => \EE_Maintenance_Mode::instance()->real_level(),
+			'served_core_versions' => array_keys(\EED_Core_Rest_Api::versions_served()),
+		);
+		$rest_response_obj->set_data($response_data);
+		return $rest_response_obj;
+	}
 }
 
 

Spacing +2 added lines, -2 removed lines

@@ -3,7 +3,7 @@ 
 
 use EventEspresso\core\libraries\rest_api\Model_Data_Translator;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -31,7 +31,7 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . 'resources~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'resources~',
                 array('version'));
             if ($matches instanceof \WP_REST_Response) {
                 return $matches;