eventespresso / event-espresso-core

core/libraries/rest_api/controllers/rpc/Checkin.php

Spacing +6 added lines, -6 removed lines

@@ -13,7 +13,7 @@ 
 use EventEspresso\core\libraries\rest_api\controllers\Base as Base;
 use EventEspresso\core\libraries\rest_api\controllers\model\Read;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -63,7 +63,7 @@ 
             $force = false;
         }
         $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
+        if ( ! $reg instanceof EE_Registration) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_registration_toggle_checkin_invalid_id',
@@ -76,7 +76,7 @@ 
                 )
             );
         }
-        if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
+        if ( ! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_user_cannot_toggle_checkin',
@@ -91,7 +91,7 @@ 
         $success = $reg->toggle_checkin_status($dtt_id, ! $force);
         if ($success === false) {
             //check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
+            if ( ! $reg->is_approved() && ! $force) {
                 //rely on EE_Error::add_error messages to have been added to give more data about why it failed
                 return $this->sendResponse(
                     new WP_Error(
@@ -119,7 +119,7 @@ 
                 ),
             )
         );
-        if (! $checkin instanceof EE_Checkin) {
+        if ( ! $checkin instanceof EE_Checkin) {
             return $this->sendResponse(
                 new WP_Error(
                     'rest_toggle_checkin_error',
@@ -134,7 +134,7 @@ 
         }
         $get_request = new WP_REST_Request(
             'GET',
-            '/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
+            '/'.EED_Core_Rest_Api::ee_api_namespace.'v'.$version.'/checkins/'.$checkin->ID()
         );
         $get_request->set_url_params(
             array(

Indentation +119 added lines, -120 removed lines

@@ -14,7 +14,7 @@ 
 use EventEspresso\core\libraries\rest_api\controllers\model\Read;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -31,126 +31,125 @@ 
 class Checkin extends Base
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string           $version
-     * @return WP_Error|WP_REST_Response
-     */
-    public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
-    {
-        $controller = new Checkin();
-        return $controller->createCheckinCheckoutObject($request, $version);
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string           $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	public static function handleRequestToggleCheckin(WP_REST_Request $request, $version)
+	{
+		$controller = new Checkin();
+		return $controller->createCheckinCheckoutObject($request, $version);
+	}
 
 
 
-    /**
-     * Toggles whether the user is checked in or not.
-
-     *
-     * @param WP_REST_Request $request
-     * @param string           $version
-     * @return WP_Error|WP_REST_Response
-     */
-    protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
-    {
-        $reg_id = $request->get_param('REG_ID');
-        $dtt_id = $request->get_param('DTT_ID');
-        $force = $request->get_param('force');
-        if ($force == 'true') {
-            $force = true;
-        } else {
-            $force = false;
-        }
-        $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_registration_toggle_checkin_invalid_id',
-                    sprintf(
-                        __(
-                            'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
-                            'event_espresso'
-                        ),
-                        $reg_id
-                    ),
-                    array('status' => 422)
-                )
-            );
-        }
-        if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_user_cannot_toggle_checkin',
-                    sprintf(
-                        __('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 403)
-                )
-            );
-        }
-        $success = $reg->toggle_checkin_status($dtt_id, ! $force);
-        if ($success === false) {
-            //check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
-                //rely on EE_Error::add_error messages to have been added to give more data about why it failed
-                return $this->sendResponse(
-                    new WP_Error(
-                        'rest_toggle_checkin_failed',
-                        __(
-                            // @codingStandardsIgnoreStart
-                            'Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_failed_not_forceable',
-                    __('Registration checkin failed. Please see additional error data.', 'event_espresso')
-                )
-            );
-        }
-        $checkin = EEM_Checkin::instance()->get_one(
-            array(
-                array(
-                    'REG_ID' => $reg_id,
-                    'DTT_ID' => $dtt_id,
-                ),
-                'order_by' => array(
-                    'CHK_timestamp' => 'DESC',
-                ),
-            )
-        );
-        if (! $checkin instanceof EE_Checkin) {
-            return $this->sendResponse(
-                new WP_Error(
-                    'rest_toggle_checkin_error',
-                    sprintf(
-                        __(
-                            // @codingStandardsIgnoreStart
-                            'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $reg_id,
-                        $dtt_id
-                    )
-                )
-            );
-        }
-        $get_request = new WP_REST_Request(
-            'GET',
-            '/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
-        );
-        $get_request->set_url_params(
-            array(
-                'id' => $checkin->ID(),
-            )
-        );
-        return Read::handleRequestGetOne($get_request, $version, 'Checkin');
-    }
+	/**
+	 * Toggles whether the user is checked in or not.
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string           $version
+	 * @return WP_Error|WP_REST_Response
+	 */
+	protected function createCheckinCheckoutObject(WP_REST_Request $request, $version)
+	{
+		$reg_id = $request->get_param('REG_ID');
+		$dtt_id = $request->get_param('DTT_ID');
+		$force = $request->get_param('force');
+		if ($force == 'true') {
+			$force = true;
+		} else {
+			$force = false;
+		}
+		$reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $reg instanceof EE_Registration) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_registration_toggle_checkin_invalid_id',
+					sprintf(
+						__(
+							'You cannot checkin registration with ID %1$s because it doesn\'t exist.',
+							'event_espresso'
+						),
+						$reg_id
+					),
+					array('status' => 422)
+				)
+			);
+		}
+		if (! EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_user_cannot_toggle_checkin',
+					sprintf(
+						__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
+						$reg_id
+					),
+					array('status' => 403)
+				)
+			);
+		}
+		$success = $reg->toggle_checkin_status($dtt_id, ! $force);
+		if ($success === false) {
+			//check if we know they can't check in because they're not approved and we aren't forcing
+			if (! $reg->is_approved() && ! $force) {
+				//rely on EE_Error::add_error messages to have been added to give more data about why it failed
+				return $this->sendResponse(
+					new WP_Error(
+						'rest_toggle_checkin_failed',
+						__(
+							// @codingStandardsIgnoreStart
+							'Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						)
+					)
+				);
+			}
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_failed_not_forceable',
+					__('Registration checkin failed. Please see additional error data.', 'event_espresso')
+				)
+			);
+		}
+		$checkin = EEM_Checkin::instance()->get_one(
+			array(
+				array(
+					'REG_ID' => $reg_id,
+					'DTT_ID' => $dtt_id,
+				),
+				'order_by' => array(
+					'CHK_timestamp' => 'DESC',
+				),
+			)
+		);
+		if (! $checkin instanceof EE_Checkin) {
+			return $this->sendResponse(
+				new WP_Error(
+					'rest_toggle_checkin_error',
+					sprintf(
+						__(
+							// @codingStandardsIgnoreStart
+							'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$reg_id,
+						$dtt_id
+					)
+				)
+			);
+		}
+		$get_request = new WP_REST_Request(
+			'GET',
+			'/' . EED_Core_Rest_Api::ee_api_namespace . 'v' . $version . '/checkins/' . $checkin->ID()
+		);
+		$get_request->set_url_params(
+			array(
+				'id' => $checkin->ID(),
+			)
+		);
+		return Read::handleRequestGetOne($get_request, $version, 'Checkin');
+	}
 }

core/libraries/rest_api/changes/ChangesIn40833.php

Indentation +49 added lines, -49 removed lines

@@ -7,59 +7,59 @@
 class ChangesIn40833 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        //set a hook to remove the checkout/checkout endpoints if the request
-        //is for lower than 4.8.33
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            array($this, 'removeCheckinRoutesEarlierThan4833'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            array($this, 'dontAddHeadersFromEeNotices'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		//set a hook to remove the checkout/checkout endpoints if the request
+		//is for lower than 4.8.33
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			array($this, 'removeCheckinRoutesEarlierThan4833'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			array($this, 'dontAddHeadersFromEeNotices'),
+			10,
+			2
+		);
+	}
 
 
 
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $routes_on_this_version
-     * @param string $version
-     * @return array like $routes_on_this_version
-     */
-    public function removeCheckinRoutesEarlierThan4833($routes_on_this_version, $version)
-    {
-        if ($this->appliesToVersion($version)) {
-            unset($routes_on_this_version['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)']);
-        }
-        return $routes_on_this_version;
-    }
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $routes_on_this_version
+	 * @param string $version
+	 * @return array like $routes_on_this_version
+	 */
+	public function removeCheckinRoutesEarlierThan4833($routes_on_this_version, $version)
+	{
+		if ($this->appliesToVersion($version)) {
+			unset($routes_on_this_version['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)']);
+		}
+		return $routes_on_this_version;
+	}
 
 
 
-    /**
-     * We just added headers for notices in this version
-     *
-     * @param array  $headers_from_ee_notices
-     * @param string $requested_version
-     * @return array
-     */
-    public function dontAddHeadersFromEeNotices($headers_from_ee_notices, $requested_version)
-    {
-        if ($this->appliesToVersion($requested_version)) {
-            return array();
-        }
-        return $headers_from_ee_notices;
-    }
+	/**
+	 * We just added headers for notices in this version
+	 *
+	 * @param array  $headers_from_ee_notices
+	 * @param string $requested_version
+	 * @return array
+	 */
+	public function dontAddHeadersFromEeNotices($headers_from_ee_notices, $requested_version)
+	{
+		if ($this->appliesToVersion($requested_version)) {
+			return array();
+		}
+		return $headers_from_ee_notices;
+	}
 }

core/libraries/rest_api/changes/ChangesIn40834.php

Indentation +35 added lines, -35 removed lines

@@ -12,39 +12,39 @@
 class ChangesIn40834 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        //set a hook to remove the checkout/checkout endpoints if the request
-        //is for lower than 4.8.33
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'removeResponseHeaders'),
-            10,
-            3
-        );
-    }
-
-
-
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $response_headers
-     * @param Base   $controller
-     * @param string $requested_version
-     * @return array like $routes_on_this_version
-     */
-    public function removeResponseHeaders($response_headers, $controller, $requested_version)
-    {
-        if ($controller instanceof Base
-            && $this->appliesToVersion($requested_version)
-        ) {
-            return array();
-        }
-        return $response_headers;
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		//set a hook to remove the checkout/checkout endpoints if the request
+		//is for lower than 4.8.33
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'removeResponseHeaders'),
+			10,
+			3
+		);
+	}
+
+
+
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $response_headers
+	 * @param Base   $controller
+	 * @param string $requested_version
+	 * @return array like $routes_on_this_version
+	 */
+	public function removeResponseHeaders($response_headers, $controller, $requested_version)
+	{
+		if ($controller instanceof Base
+			&& $this->appliesToVersion($requested_version)
+		) {
+			return array();
+		}
+		return $response_headers;
+	}
 }

core/libraries/rest_api/changes/ChangesIn40836.php

Indentation +175 added lines, -175 removed lines

@@ -16,179 +16,179 @@
 class ChangesIn40836 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        //set a hook to remove the "calculate" query param
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array($this, 'removeCalculateQueryParam'),
-            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, 'removeCalculatedFieldsFromResponse'),
-            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, 'removeHeadersNewInThisVersion'),
-            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, 'addOldFeaturedImagePartOfCptEntities'),
-            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, 'useNegativeOneForInfinityBeforeThisVersion'),
-            10,
-            4
-        );
-    }
-
-
-
-    /**
-     * Don't 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 removeCalculateQueryParam($query_params, EEM_Base $model, $version)
-    {
-        if ($this->appliesToVersion($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 removeCalculatedFieldsFromResponse(
-        $entity_response_array,
-        EEM_Base $model,
-        $request_context,
-        WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) {
-            unset($entity_response_array['_calculated_fields']);
-        }
-        return $entity_response_array;
-    }
-
-
-
-    /**
-     * Removes the new headers for requests before 4.8.36
-     *
-     * @param array           $headers
-     * @param Controller_Base $controller
-     * @param string          $version
-     * @return array
-     */
-    public function removeHeadersNewInThisVersion(
-        $headers,
-        Controller_Base $controller,
-        $version
-    ) {
-        if ($this->appliesToVersion($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 addOldFeaturedImagePartOfCptEntities(
-        $entity_response_array,
-        EEM_Base $model,
-        $request_context,
-        WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())
-            && $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 useNegativeOneForInfinityBeforeThisVersion(
-        $new_value,
-        $field_obj,
-        $original_value,
-        $requested_value
-    ) {
-        if ($this->appliesToVersion($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 setHooks()
+	{
+		//set a hook to remove the "calculate" query param
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array($this, 'removeCalculateQueryParam'),
+			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, 'removeCalculatedFieldsFromResponse'),
+			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, 'removeHeadersNewInThisVersion'),
+			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, 'addOldFeaturedImagePartOfCptEntities'),
+			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, 'useNegativeOneForInfinityBeforeThisVersion'),
+			10,
+			4
+		);
+	}
+
+
+
+	/**
+	 * Don't 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 removeCalculateQueryParam($query_params, EEM_Base $model, $version)
+	{
+		if ($this->appliesToVersion($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 removeCalculatedFieldsFromResponse(
+		$entity_response_array,
+		EEM_Base $model,
+		$request_context,
+		WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())) {
+			unset($entity_response_array['_calculated_fields']);
+		}
+		return $entity_response_array;
+	}
+
+
+
+	/**
+	 * Removes the new headers for requests before 4.8.36
+	 *
+	 * @param array           $headers
+	 * @param Controller_Base $controller
+	 * @param string          $version
+	 * @return array
+	 */
+	public function removeHeadersNewInThisVersion(
+		$headers,
+		Controller_Base $controller,
+		$version
+	) {
+		if ($this->appliesToVersion($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 addOldFeaturedImagePartOfCptEntities(
+		$entity_response_array,
+		EEM_Base $model,
+		$request_context,
+		WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->appliesToVersion($controller->getModelVersionInfo()->requestedVersion())
+			&& $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 useNegativeOneForInfinityBeforeThisVersion(
+		$new_value,
+		$field_obj,
+		$original_value,
+		$requested_value
+	) {
+		if ($this->appliesToVersion($requested_value)
+			&& $original_value === EE_INF
+		) {
+			//return the old representation of infinity in the JSON
+			return -1;
+		}
+		return $new_value;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -124,9 +124,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',
                     )
                 )
             );

core/libraries/rest_api/calculations/Datetime.php

Indentation +132 added lines, -132 removed lines

@@ -17,7 +17,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -25,144 +25,144 @@ 
 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 spacesRemainingConsideringTickets($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(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        '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 spacesRemainingConsideringTickets($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(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'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\RestException
-     */
-    public static function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('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\RestException
+	 */
+	public static function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('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\RestException
-     */
-    public static function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('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\RestException
+	 */
+	public static function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('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\RestException
-     */
-    public static function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('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\RestException
+	 */
+	public static function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('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

@@ -16,7 +16,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -75,7 +75,7 @@ 
      */
     public static function registrationsCheckedInCount($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(
                     __(
@@ -107,7 +107,7 @@ 
      */
     public static function registrationsCheckedOutCount($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(
                     __(
@@ -140,7 +140,7 @@ 
      */
     public static function spotsTakenPendingPayment($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(
                     __(

core/libraries/rest_api/calculations/Event.php

Indentation +375 added lines, -375 removed lines

@@ -19,7 +19,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,378 +27,378 @@ 
 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 optimumSalesAtStart($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(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        '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 optimumSalesNow($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(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        '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 spacesRemaining($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(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        '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 spotsTaken($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        '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 RestException
-     */
-    public static function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('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 RestException
-     */
-    public static function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('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 RestException
-     */
-    public static function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::verifyCurrentUserCan('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 imageThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($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 imageMedium($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($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 imageMediumLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($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 imageLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($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 imagePostThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($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 imageFull($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($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 calculateImageData($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 optimumSalesAtStart($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(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'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 optimumSalesNow($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(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'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 spacesRemaining($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(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'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 spotsTaken($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'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 RestException
+	 */
+	public static function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('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 RestException
+	 */
+	public static function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('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 RestException
+	 */
+	public static function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::verifyCurrentUserCan('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 imageThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($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 imageMedium($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($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 imageMediumLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($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 imageLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($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 imagePostThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($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 imageFull($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($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 calculateImageData($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

@@ -18,7 +18,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -152,7 +152,7 @@ 
      */
     public static function spotsTaken($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(
                     __(
@@ -192,7 +192,7 @@ 
      */
     public static function spotsTakenPendingPayment($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(
                     __(
@@ -233,7 +233,7 @@ 
      */
     public static function registrationsCheckedInCount($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(
                     __(
@@ -265,7 +265,7 @@ 
      */
     public static function registrationsCheckedOutCount($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(
                     __(
@@ -386,7 +386,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/RestException.php

Indentation +41 added lines, -41 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,54 +20,54 @@ 
 class RestException 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)
-    {
-        if (is_array($wp_error_data)
-            && isset($wp_error_data['status'])
-        ) {
-            $http_status_number = $wp_error_data['status'];
-        } else {
-            $http_status_number = 500;
-        }
-        parent::__construct(
-            $message,
-            $http_status_number,
-            $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)
+	{
+		if (is_array($wp_error_data)
+			&& isset($wp_error_data['status'])
+		) {
+			$http_status_number = $wp_error_data['status'];
+		} else {
+			$http_status_number = 500;
+		}
+		parent::__construct(
+			$message,
+			$http_status_number,
+			$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 getData()
-    {
-        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 getData()
+	{
+		return $this->wp_error_data;
+	}
 
 
 
-    /**
-     * Gets the error string
-     *
-     * @return string
-     */
-    public function getStringCode()
-    {
-        return $this->wp_error_code;
-    }
+	/**
+	 * Gets the error string
+	 *
+	 * @return string
+	 */
+	public function getStringCode()
+	{
+		return $this->wp_error_code;
+	}
 }

core/libraries/rest_api/Capabilities.php

Indentation +153 added lines, -153 removed lines

@@ -5,7 +5,7 @@ 
 use EEH_Inflector;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,158 +20,158 @@ 
 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 currentUserHasPartialAccessTo($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 getMissingPermissions($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 getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
-    {
-        return implode(',', array_keys(self::getMissingPermissions($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 ModelVersionInfo $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 filterOutInaccessibleEntityFields(
-        $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->fieldHasRenderedFormat($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
-        );
-    }
-
-
-
-    /**
-     * Verifies the current user has at least partial access to do this action on this model.
-     * If not, throws an exception (so we can define the code that sets up this error object
-     * once)
-     *
-     * @param EEM_Base $model
-     * @param string   $model_action_context
-     * @param string   $action_name
-     * @return void
-     * @throws RestException
-     */
-    public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
-    {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
-                    $action_name,
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $model_action_context)
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * 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 currentUserHasPartialAccessTo($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 getMissingPermissions($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 getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
+	{
+		return implode(',', array_keys(self::getMissingPermissions($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 ModelVersionInfo $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 filterOutInaccessibleEntityFields(
+		$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->fieldHasRenderedFormat($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
+		);
+	}
+
+
+
+	/**
+	 * Verifies the current user has at least partial access to do this action on this model.
+	 * If not, throws an exception (so we can define the code that sets up this error object
+	 * once)
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_action_context
+	 * @param string   $action_name
+	 * @return void
+	 * @throws RestException
+	 */
+	public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
+	{
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
+					$action_name,
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $model_action_context)
+				),
+				array('status' => 403)
+			);
+		}
+	}
 }
 
 // End of file Capabilities.php

Spacing +2 added lines, -2 removed lines

@@ -4,7 +4,7 @@ 
 use EEM_Base;
 use EEH_Inflector;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -158,7 +158,7 @@ 
      */
     public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
     {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),

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

Indentation +110 added lines, -110 removed lines

@@ -12,7 +12,7 @@ 
 use EventEspresso\core\libraries\rest_api\ModelDataTranslator;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -29,124 +29,124 @@ 
 {
 
 
-    /**
-     * @param \WP_REST_Request $request
-     * @param string           $version
-     * @return array|\WP_REST_Response
-     */
-    public static function handleRequestModelsMeta(\WP_REST_Request $request, $version)
-    {
-        $controller = new Meta();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse($controller->getModelsMetadataEntity());
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * @param \WP_REST_Request $request
+	 * @param string           $version
+	 * @return array|\WP_REST_Response
+	 */
+	public static function handleRequestModelsMeta(\WP_REST_Request $request, $version)
+	{
+		$controller = new Meta();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse($controller->getModelsMetadataEntity());
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
 
-    /*
+	/*
      * Gets the model metadata resource entity
      * @return array for JSON response, describing all the models available in teh requested version
      */
-    protected function getModelsMetadataEntity()
-    {
-        $response = array();
-        foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
-            $model = $this->getModelVersionInfo()->loadModel($model_name);
-            $fields_json = array();
-            foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
-                if ($this->getModelVersionInfo()->fieldIsIgnored($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 = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-                $field_json = array(
-                    'name'                => $field_name,
-                    'nicename'            => $field_obj->get_nicename(),
-                    'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
-                    'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($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->getModelVersionInfo()->extraResourcePropertiesForModel($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 getModelsMetadataEntity()
+	{
+		$response = array();
+		foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
+			$model = $this->getModelVersionInfo()->loadModel($model_name);
+			$fields_json = array();
+			foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
+				if ($this->getModelVersionInfo()->fieldIsIgnored($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 = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+				$field_json = array(
+					'name'                => $field_name,
+					'nicename'            => $field_obj->get_nicename(),
+					'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
+					'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($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->getModelVersionInfo()->extraResourcePropertiesForModel($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 filterEeMetadataIntoIndex(\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(),
-            // @codingStandardsIgnoreStart
-            'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
-            // @codingStandardsIgnoreEnd
-            '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 filterEeMetadataIntoIndex(\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(),
+			// @codingStandardsIgnoreStart
+			'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
+			// @codingStandardsIgnoreEnd
+			'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 +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 use EEM_System_Status;
 use EventEspresso\core\libraries\rest_api\ModelDataTranslator;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }