eventespresso / event-espresso-core

core/libraries/iframe_display/IframeEmbedButton.php

Indentation +245 added lines, -245 removed lines

@@ -13,274 +13,274 @@
 {
 
 
-    /**
-     * @var string $iframe_name
-     */
-    private $iframe_name;
+	/**
+	 * @var string $iframe_name
+	 */
+	private $iframe_name;
 
-    /**
-     * @var string $route_name
-     */
-    private $route_name;
+	/**
+	 * @var string $route_name
+	 */
+	private $route_name;
 
-    /**
-     * @var string $slug
-     */
-    private $slug;
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
 
-    /**
-     * @var boolean $append_filterable_content
-     */
-    private $append_filterable_content;
+	/**
+	 * @var boolean $append_filterable_content
+	 */
+	private $append_filterable_content;
 
 
-    /**
-     * IframeEmbedButton constructor.
-     *
-     * @param string $iframe_name i18n name for the iframe. This will be used in HTML
-     * @param string $route_name  the name of the registered route
-     * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
-     *                            will most likely be "event" since that's the only usage atm
-     */
-    public function __construct($iframe_name, $route_name, $slug = 'event')
-    {
-        $this->iframe_name = $iframe_name;
-        $this->route_name = $route_name;
-        $this->slug = $slug;
-    }
+	/**
+	 * IframeEmbedButton constructor.
+	 *
+	 * @param string $iframe_name i18n name for the iframe. This will be used in HTML
+	 * @param string $route_name  the name of the registered route
+	 * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
+	 *                            will most likely be "event" since that's the only usage atm
+	 */
+	public function __construct($iframe_name, $route_name, $slug = 'event')
+	{
+		$this->iframe_name = $iframe_name;
+		$this->route_name = $route_name;
+		$this->slug = $slug;
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     */
-    public function addEventEditorIframeEmbedButtonFilter()
-    {
-        // add button for iframe code to event editor.
-        add_filter(
-            'get_sample_permalink_html',
-            array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
-            10,
-            2
-        );
-        add_action(
-            'admin_enqueue_scripts',
-            array($this, 'embedButtonAssets'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 */
+	public function addEventEditorIframeEmbedButtonFilter()
+	{
+		// add button for iframe code to event editor.
+		add_filter(
+			'get_sample_permalink_html',
+			array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
+			10,
+			2
+		);
+		add_action(
+			'admin_enqueue_scripts',
+			array($this, 'embedButtonAssets'),
+			10
+		);
+	}
 
 
-    /**
-     * @param $permalink_string
-     * @param $id
-     * @return string
-     */
-    public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
-    {
-        return $this->eventEditorIframeEmbedButton(
-            $permalink_string,
-            $id
-        );
-    }
+	/**
+	 * @param $permalink_string
+	 * @param $id
+	 * @return string
+	 */
+	public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
+	{
+		return $this->eventEditorIframeEmbedButton(
+			$permalink_string,
+			$id
+		);
+	}
 
 
-    /**
-     * iframe embed code button to the Event editor.
-     *
-     * @param string $permalink_string
-     * @param int    $id
-     * @return string
-     */
-    public function eventEditorIframeEmbedButton(
-        $permalink_string,
-        $id
-    ) {
-        // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
-            $post = get_post($id);
-            // if NOT event then let's get out.
-            if ($post->post_type !== 'espresso_events') {
-                return $permalink_string;
-            }
-            $permalink_string .= $this->embedButtonHtml(
-                array($this->slug => $id),
-                'button-small'
-            );
-        }
-        return $permalink_string;
-    }
+	/**
+	 * iframe embed code button to the Event editor.
+	 *
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @return string
+	 */
+	public function eventEditorIframeEmbedButton(
+		$permalink_string,
+		$id
+	) {
+		// make sure this is ONLY when editing and the event id has been set.
+		if (! empty($id)) {
+			$post = get_post($id);
+			// if NOT event then let's get out.
+			if ($post->post_type !== 'espresso_events') {
+				return $permalink_string;
+			}
+			$permalink_string .= $this->embedButtonHtml(
+				array($this->slug => $id),
+				'button-small'
+			);
+		}
+		return $permalink_string;
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
-     *
-     * @param string $action name of the WP do_action() to hook into
-     */
-    public function addActionIframeEmbedButton($action)
-    {
-        // add button for iframe code to event editor.
-        add_action(
-            $action,
-            array($this, 'addActionIframeEmbedButtonCallback'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
+	 *
+	 * @param string $action name of the WP do_action() to hook into
+	 */
+	public function addActionIframeEmbedButton($action)
+	{
+		// add button for iframe code to event editor.
+		add_action(
+			$action,
+			array($this, 'addActionIframeEmbedButtonCallback'),
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    public function addActionIframeEmbedButtonCallback()
-    {
-        echo $this->embedButtonHtml();
-    }
+	/**
+	 * @return void
+	 */
+	public function addActionIframeEmbedButtonCallback()
+	{
+		echo $this->embedButtonHtml();
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
-     *
-     * @param string $filter     name of the WP apply_filters() to hook into
-     * @param bool   $append     if true, will add iframe embed button to end of content,
-     *                           else if false, will add to the beginning of the content
-     */
-    public function addFilterIframeEmbedButton($filter, $append = true)
-    {
-        $this->append_filterable_content = $append;
-        // add button for iframe code to event editor.
-        add_filter(
-            $filter,
-            array($this, 'addFilterIframeEmbedButtonCallback'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
+	 *
+	 * @param string $filter     name of the WP apply_filters() to hook into
+	 * @param bool   $append     if true, will add iframe embed button to end of content,
+	 *                           else if false, will add to the beginning of the content
+	 */
+	public function addFilterIframeEmbedButton($filter, $append = true)
+	{
+		$this->append_filterable_content = $append;
+		// add button for iframe code to event editor.
+		add_filter(
+			$filter,
+			array($this, 'addFilterIframeEmbedButtonCallback'),
+			10
+		);
+	}
 
 
-    /**
-     * @param array|string $filterable_content
-     * @return array|string
-     */
-    public function addFilterIframeEmbedButtonCallback($filterable_content)
-    {
-        $embedButtonHtml = $this->embedButtonHtml();
-        if (is_array($filterable_content)) {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content + array($this->route_name => $embedButtonHtml)
-                : array($this->route_name => $embedButtonHtml) + $filterable_content;
-        } else {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
-        }
-        return $filterable_content;
-    }
+	/**
+	 * @param array|string $filterable_content
+	 * @return array|string
+	 */
+	public function addFilterIframeEmbedButtonCallback($filterable_content)
+	{
+		$embedButtonHtml = $this->embedButtonHtml();
+		if (is_array($filterable_content)) {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content + array($this->route_name => $embedButtonHtml)
+				: array($this->route_name => $embedButtonHtml) + $filterable_content;
+		} else {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content . $embedButtonHtml
+				: $embedButtonHtml . $filterable_content;
+		}
+		return $filterable_content;
+	}
 
 
-    /**
-     * iframe_embed_html
-     *
-     * @param array  $query_args
-     * @param string $button_class
-     * @return string
-     */
-    public function embedButtonHtml($query_args = array(), $button_class = '')
-    {
-        // incoming args will replace the defaults listed here in the second array (union preserves first array)
-        $query_args = (array) $query_args + array($this->route_name => 'iframe');
-        $query_args = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
-            $query_args
-        );
-        // add this route to our localized vars
-        $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
-            ? \EE_Registry::$i18n_js_strings['iframe_module_routes']
-            : array();
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
-        \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
-        $iframe_embed_html = \EEH_HTML::link(
-            '#',
-            sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
-            sprintf(
-                esc_html__(
-                    'click here to generate code for embedding %1$s iframe into another site.',
-                    'event_espresso'
-                ),
-                \EEH_Inflector::add_indefinite_article($this->iframe_name)
-            ),
-            "{$this->route_name}-iframe-embed-trigger-js",
-            'iframe-embed-trigger-js button ' . $button_class,
-            '',
-            ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
-        );
-        $iframe_embed_html .= \EEH_HTML::div(
-            '',
-            "{$this->route_name}-iframe-js",
-            'iframe-embed-wrapper-js',
-            'display:none;'
-        );
-        $iframe_embed_html .= esc_html(
-            \EEH_HTML::div(
-                '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
-                '',
-                '',
-                'width:100%; height: 500px;'
-            )
-        );
-        $iframe_embed_html .= \EEH_HTML::divx();
-        return $iframe_embed_html;
-    }
+	/**
+	 * iframe_embed_html
+	 *
+	 * @param array  $query_args
+	 * @param string $button_class
+	 * @return string
+	 */
+	public function embedButtonHtml($query_args = array(), $button_class = '')
+	{
+		// incoming args will replace the defaults listed here in the second array (union preserves first array)
+		$query_args = (array) $query_args + array($this->route_name => 'iframe');
+		$query_args = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
+			$query_args
+		);
+		// add this route to our localized vars
+		$iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
+			? \EE_Registry::$i18n_js_strings['iframe_module_routes']
+			: array();
+		$iframe_module_routes[ $this->route_name ] = $this->route_name;
+		\EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
+		$iframe_embed_html = \EEH_HTML::link(
+			'#',
+			sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
+			sprintf(
+				esc_html__(
+					'click here to generate code for embedding %1$s iframe into another site.',
+					'event_espresso'
+				),
+				\EEH_Inflector::add_indefinite_article($this->iframe_name)
+			),
+			"{$this->route_name}-iframe-embed-trigger-js",
+			'iframe-embed-trigger-js button ' . $button_class,
+			'',
+			' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
+		);
+		$iframe_embed_html .= \EEH_HTML::div(
+			'',
+			"{$this->route_name}-iframe-js",
+			'iframe-embed-wrapper-js',
+			'display:none;'
+		);
+		$iframe_embed_html .= esc_html(
+			\EEH_HTML::div(
+				'<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
+				'',
+				'',
+				'width:100%; height: 500px;'
+			)
+		);
+		$iframe_embed_html .= \EEH_HTML::divx();
+		return $iframe_embed_html;
+	}
 
 
-    /**
-     * enqueue iframe button js
-     */
-    public function embedButtonAssets()
-    {
-        \EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
-            'copy and paste the following into any other site\'s content to display this event:',
-            'event_espresso'
-        );
-        \EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
-            'click anywhere outside of this window to close it.',
-            'event_espresso'
-        );
-        wp_register_script(
-            'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
-            array('ee-dialog'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('iframe_embed_button');
-    }
+	/**
+	 * enqueue iframe button js
+	 */
+	public function embedButtonAssets()
+	{
+		\EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
+			'copy and paste the following into any other site\'s content to display this event:',
+			'event_espresso'
+		);
+		\EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
+			'click anywhere outside of this window to close it.',
+			'event_espresso'
+		);
+		wp_register_script(
+			'iframe_embed_button',
+			plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+			array('ee-dialog'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('iframe_embed_button');
+	}
 
 
-    /**
-     * generates embed button sections for admin pages
-     *
-     * @param array $embed_buttons
-     * @return string
-     */
-    public function addIframeEmbedButtonsSection(array $embed_buttons)
-    {
-        $embed_buttons = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
-            $embed_buttons
-        );
-        if (empty($embed_buttons)) {
-            return '';
-        }
-        // add button for iframe code to event editor.
-        $html = \EEH_HTML::br(2);
-        $html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
-        $html .= \EEH_HTML::p(
-            esc_html__(
-                'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
-                'event_espresso'
-            )
-        );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
-        $html .= \EEH_HTML::br(2);
-        return $html;
-    }
+	/**
+	 * generates embed button sections for admin pages
+	 *
+	 * @param array $embed_buttons
+	 * @return string
+	 */
+	public function addIframeEmbedButtonsSection(array $embed_buttons)
+	{
+		$embed_buttons = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
+			$embed_buttons
+		);
+		if (empty($embed_buttons)) {
+			return '';
+		}
+		// add button for iframe code to event editor.
+		$html = \EEH_HTML::br(2);
+		$html .= \EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
+		$html .= \EEH_HTML::p(
+			esc_html__(
+				'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
+				'event_espresso'
+			)
+		);
+		$html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+		$html .= \EEH_HTML::br(2);
+		return $html;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -96,7 +96,7 @@ 
         $id
     ) {
         // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $post = get_post($id);
             // if NOT event then let's get out.
             if ($post->post_type !== 'espresso_events') {
@@ -169,8 +169,8 @@ 
                 : array($this->route_name => $embedButtonHtml) + $filterable_content;
         } else {
             $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
+                ? $filterable_content.$embedButtonHtml
+                : $embedButtonHtml.$filterable_content;
         }
         return $filterable_content;
     }
@@ -195,7 +195,7 @@ 
         $iframe_module_routes = isset(\EE_Registry::$i18n_js_strings['iframe_module_routes'])
             ? \EE_Registry::$i18n_js_strings['iframe_module_routes']
             : array();
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
+        $iframe_module_routes[$this->route_name] = $this->route_name;
         \EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
         $iframe_embed_html = \EEH_HTML::link(
             '#',
@@ -208,9 +208,9 @@ 
                 \EEH_Inflector::add_indefinite_article($this->iframe_name)
             ),
             "{$this->route_name}-iframe-embed-trigger-js",
-            'iframe-embed-trigger-js button ' . $button_class,
+            'iframe-embed-trigger-js button '.$button_class,
             '',
-            ' data-iframe_embed_button="#' . $this->route_name . '-iframe-js" tabindex="-1"'
+            ' data-iframe_embed_button="#'.$this->route_name.'-iframe-js" tabindex="-1"'
         );
         $iframe_embed_html .= \EEH_HTML::div(
             '',
@@ -220,7 +220,7 @@ 
         );
         $iframe_embed_html .= esc_html(
             \EEH_HTML::div(
-                '<iframe src="' . add_query_arg($query_args, site_url()) . '" width="100%" height="100%"></iframe>',
+                '<iframe src="'.add_query_arg($query_args, site_url()).'" width="100%" height="100%"></iframe>',
                 '',
                 '',
                 'width:100%; height: 500px;'
@@ -246,7 +246,7 @@ 
         );
         wp_register_script(
             'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+            plugin_dir_url(__FILE__).'iframe-embed-button.js',
             array('ee-dialog'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -279,7 +279,7 @@ 
                 'event_espresso'
             )
         );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+        $html .= ' &nbsp; '.implode(' &nbsp; ', $embed_buttons).' ';
         $html .= \EEH_HTML::br(2);
         return $html;
     }

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

Indentation +77 added lines, -77 removed lines

@@ -20,85 +20,85 @@
 class Read
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return EE_Config|WP_Error
-     */
-    public static function handleRequest(WP_REST_Request $request, $version)
-    {
-        $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
-            return EE_Config::instance();
-        } else {
-            return new WP_Error(
-                'cannot_read_config',
-                sprintf(
-                    __(
-                        'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
-                        'event_espresso'
-                    ),
-                    $cap
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return EE_Config|WP_Error
+	 */
+	public static function handleRequest(WP_REST_Request $request, $version)
+	{
+		$cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
+			return EE_Config::instance();
+		} else {
+			return new WP_Error(
+				'cannot_read_config',
+				sprintf(
+					__(
+						'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
+						'event_espresso'
+					),
+					$cap
+				),
+				array('status' => 403)
+			);
+		}
+	}
 
 
-    /**
-     * Handles the request for public site info
-     *
-     * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
-     *                                                           current user could be authenticated using basic auth
-     *                                                           data
-     * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
-     *                                                           basic auth data was somehow received
-     * @param WP_REST_Request  $request
-     * @param string           $version
-     * @return array|WP_Error
-     */
-    public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
-    {
-        global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
-        $insecure_usage_of_basic_auth = apply_filters(
-        // @codingStandardsIgnoreStart
-            'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
-            // @codingStandardsIgnoreEnd
-            $wp_json_basic_auth_success && ! is_ssl(),
-            $request
-        );
-        if ($insecure_usage_of_basic_auth) {
-            $warning = sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
-                '</a>'
-            );
-        } else {
-            $warning = '';
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
-            array(
-                'default_timezone' => array(
-                    'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
-                    'string' => get_option('timezone_string'),
-                    'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-                ),
-                'default_currency' => EE_Config::instance()->currency,
-                'authentication'   => array(
-                    'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
-                    'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
-                    'warning'                      => $warning,
-                ),
-            )
-        );
-    }
+	/**
+	 * Handles the request for public site info
+	 *
+	 * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
+	 *                                                           current user could be authenticated using basic auth
+	 *                                                           data
+	 * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
+	 *                                                           basic auth data was somehow received
+	 * @param WP_REST_Request  $request
+	 * @param string           $version
+	 * @return array|WP_Error
+	 */
+	public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
+	{
+		global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
+		$insecure_usage_of_basic_auth = apply_filters(
+		// @codingStandardsIgnoreStart
+			'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
+			// @codingStandardsIgnoreEnd
+			$wp_json_basic_auth_success && ! is_ssl(),
+			$request
+		);
+		if ($insecure_usage_of_basic_auth) {
+			$warning = sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
+				'</a>'
+			);
+		} else {
+			$warning = '';
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_rest_api_controllers_config__handleRequestSiteInfo__return_val',
+			array(
+				'default_timezone' => array(
+					'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
+					'string' => get_option('timezone_string'),
+					'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+				),
+				'default_currency' => EE_Config::instance()->currency,
+				'authentication'   => array(
+					'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
+					'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
+					'warning'                      => $warning,
+				),
+			)
+		);
+	}
 }
 
 // End of file Read.php

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

Indentation +305 added lines, -305 removed lines

@@ -30,325 +30,325 @@
 {
 
 
-    public function __construct()
-    {
-        parent::__construct();
-        EE_Registry::instance()->load_helper('Inflector');
-    }
+	public function __construct()
+	{
+		parent::__construct();
+		EE_Registry::instance()->load_helper('Inflector');
+	}
 
 
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->insert(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->insert(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Handles a request from \WP_REST_Server to update an EE model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->update(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Handles a request from \WP_REST_Server to update an EE model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->update(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Deletes a single model object and returns it. Unless
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->delete(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Deletes a single model object and returns it. Unless
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->delete(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Inserts a new model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function insert(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $submitted_json_data,
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = EE_Registry::instance()->load_class(
-            $model->get_this_model_name(),
-            array($model_data, $model->get_timezone()),
-            false,
-            false
-        );
-        $model_obj->save();
-        $new_id = $model_obj->ID();
-        if (! $new_id) {
-            throw new RestException(
-                'rest_insertion_failed',
-                sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
+	/**
+	 * Inserts a new model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function insert(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$submitted_json_data,
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = EE_Registry::instance()->load_class(
+			$model->get_this_model_name(),
+			array($model_data, $model->get_timezone()),
+			false,
+			false
+		);
+		$model_obj->save();
+		$new_id = $model_obj->ID();
+		if (! $new_id) {
+			throw new RestException(
+				'rest_insertion_failed',
+				sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
 
 
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     */
-    public function update(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        if (! $obj_id) {
-            throw new RestException(
-                'rest_edit_failed',
-                sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $this->getBodyParams($request),
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $model_obj->save($model_data);
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function update(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		if (! $obj_id) {
+			throw new RestException(
+				'rest_edit_failed',
+				sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$this->getBodyParams($request),
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$model_obj->save($model_data);
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
 
 
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array of either the soft-deleted item, or
-     * @throws EE_Error
-     */
-    public function delete(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        // this is where we would apply more fine-grained caps
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
-        $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
-        if ($requested_permanent_delete) {
-            $previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
-            $deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
-            return array(
-                'deleted'  => $deleted,
-                'previous' => $previous,
-            );
-        } else {
-            if ($model instanceof EEM_Soft_Delete_Base) {
-                $model->delete_by_ID($obj_id, $requested_allow_blocking);
-                return $this->returnModelObjAsJsonResponse($model_obj, $request);
-            } else {
-                throw new RestException(
-                    'rest_trash_not_supported',
-                    501,
-                    sprintf(
-                        esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
-                        EEH_Inflector::pluralize($model->get_this_model_name())
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array of either the soft-deleted item, or
+	 * @throws EE_Error
+	 */
+	public function delete(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		// this is where we would apply more fine-grained caps
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
+		$requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
+		if ($requested_permanent_delete) {
+			$previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
+			$deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
+			return array(
+				'deleted'  => $deleted,
+				'previous' => $previous,
+			);
+		} else {
+			if ($model instanceof EEM_Soft_Delete_Base) {
+				$model->delete_by_ID($obj_id, $requested_allow_blocking);
+				return $this->returnModelObjAsJsonResponse($model_obj, $request);
+			} else {
+				throw new RestException(
+					'rest_trash_not_supported',
+					501,
+					sprintf(
+						esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
+						EEH_Inflector::pluralize($model->get_this_model_name())
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Returns an array ready to be converted into a JSON response, based solely on the model object
-     *
-     * @param EE_Base_Class   $model_obj
-     * @param WP_REST_Request $request
-     * @return array ready for a response
-     */
-    protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
-    {
-        $model = $model_obj->get_model();
-        // create an array exactly like the wpdb results row,
-        // so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
-        $simulated_db_row = array();
-        foreach ($model->field_settings(true) as $field_name => $field_obj) {
-            // we need to reconstruct the normal wpdb results, including the db-only fields
-            // like a secondary table's primary key. The models expect those (but don't care what value they have)
-            if ($field_obj instanceof EE_DB_Only_Field_Base) {
-                $raw_value = true;
-            } elseif ($field_obj instanceof EE_Datetime_Field) {
-                $raw_value = $model_obj->get_DateTime_object($field_name);
-            } else {
-                $raw_value = $model_obj->get_raw($field_name);
-            }
-            $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
-        }
-        $read_controller = new Read();
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        // the simulates request really doesn't need any info downstream
-        $simulated_request = new WP_REST_Request('GET');
-        return $read_controller->createEntityFromWpdbResult(
-            $model_obj->get_model(),
-            $simulated_db_row,
-            $simulated_request
-        );
-    }
+	/**
+	 * Returns an array ready to be converted into a JSON response, based solely on the model object
+	 *
+	 * @param EE_Base_Class   $model_obj
+	 * @param WP_REST_Request $request
+	 * @return array ready for a response
+	 */
+	protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
+	{
+		$model = $model_obj->get_model();
+		// create an array exactly like the wpdb results row,
+		// so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
+		$simulated_db_row = array();
+		foreach ($model->field_settings(true) as $field_name => $field_obj) {
+			// we need to reconstruct the normal wpdb results, including the db-only fields
+			// like a secondary table's primary key. The models expect those (but don't care what value they have)
+			if ($field_obj instanceof EE_DB_Only_Field_Base) {
+				$raw_value = true;
+			} elseif ($field_obj instanceof EE_Datetime_Field) {
+				$raw_value = $model_obj->get_DateTime_object($field_name);
+			} else {
+				$raw_value = $model_obj->get_raw($field_name);
+			}
+			$simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
+		}
+		$read_controller = new Read();
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		// the simulates request really doesn't need any info downstream
+		$simulated_request = new WP_REST_Request('GET');
+		return $read_controller->createEntityFromWpdbResult(
+			$model_obj->get_model(),
+			$simulated_db_row,
+			$simulated_request
+		);
+	}
 
 
-    /**
-     * Gets the item affected by this request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param  int|string     $obj_id
-     * @return \WP_Error|array
-     */
-    protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
-    {
-        $requested_version = $this->getRequestedVersion($request->get_route());
-        $get_request = new WP_REST_Request(
-            'GET',
-            EED_Core_Rest_Api::ee_api_namespace
-            . $requested_version
-            . '/'
-            . EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-            . '/'
-            . $obj_id
-        );
-        $get_request->set_url_params(
-            array(
-                'id'      => $obj_id,
-                'include' => $request->get_param('include'),
-            )
-        );
-        $read_controller = new Read();
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        return $read_controller->getEntityFromModel($model, $get_request);
-    }
+	/**
+	 * Gets the item affected by this request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param  int|string     $obj_id
+	 * @return \WP_Error|array
+	 */
+	protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
+	{
+		$requested_version = $this->getRequestedVersion($request->get_route());
+		$get_request = new WP_REST_Request(
+			'GET',
+			EED_Core_Rest_Api::ee_api_namespace
+			. $requested_version
+			. '/'
+			. EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+			. '/'
+			. $obj_id
+		);
+		$get_request->set_url_params(
+			array(
+				'id'      => $obj_id,
+				'include' => $request->get_param('include'),
+			)
+		);
+		$read_controller = new Read();
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		return $read_controller->getEntityFromModel($model, $get_request);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -125,9 +125,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_create_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -155,7 +155,7 @@ 
         );
         $model_obj->save();
         $new_id = $model_obj->ID();
-        if (! $new_id) {
+        if ( ! $new_id) {
             throw new RestException(
                 'rest_insertion_failed',
                 sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -177,9 +177,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_edit_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -193,7 +193,7 @@ 
             );
         }
         $obj_id = $request->get_param('id');
-        if (! $obj_id) {
+        if ( ! $obj_id) {
             throw new RestException(
                 'rest_edit_failed',
                 sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -206,7 +206,7 @@ 
             true
         );
         $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
+        if ( ! $model_obj instanceof EE_Base_Class) {
             $lowercase_model_name = strtolower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_invalid_id', $lowercase_model_name),
@@ -231,9 +231,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_delete_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -249,7 +249,7 @@ 
         $obj_id = $request->get_param('id');
         // this is where we would apply more fine-grained caps
         $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
+        if ( ! $model_obj instanceof EE_Base_Class) {
             $lowercase_model_name = strtolower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_invalid_id', $lowercase_model_name),
@@ -307,7 +307,7 @@ 
             } else {
                 $raw_value = $model_obj->get_raw($field_name);
             }
-            $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
+            $simulated_db_row[$field_obj->get_qualified_column()] = $field_obj->prepare_for_use_in_db($raw_value);
         }
         $read_controller = new Read();
         $read_controller->setRequestedVersion($this->getRequestedVersion());

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

Indentation +109 added lines, -109 removed lines

@@ -23,122 +23,122 @@
 {
 
 
-    /**
-     * @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'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
-                    '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'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
+					'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 +5 added lines, -5 removed lines

@@ -80,13 +80,13 @@ 
                     'table_alias'         => $field_obj->get_table_alias(),
                     'table_column'        => $field_obj->get_table_column(),
                 );
-                $fields_json[ $field_json['name'] ] = $field_json;
+                $fields_json[$field_json['name']] = $field_json;
             }
             $fields_json = array_merge(
                 $fields_json,
                 $this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
             );
-            $response[ $model_name ]['fields'] = apply_filters(
+            $response[$model_name]['fields'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__fields',
                 $fields_json,
                 $model
@@ -98,9 +98,9 @@ 
                     'type'   => str_replace('EE_', '', get_class($relation_obj)),
                     'single' => $relation_obj instanceof \EE_Belongs_To_Relation ? true : false,
                 );
-                $relations_json[ $relation_name ] = $relation_json;
+                $relations_json[$relation_name] = $relation_json;
             }
-            $response[ $model_name ]['relations'] = apply_filters(
+            $response[$model_name]['relations'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__relations',
                 $relations_json,
                 $model
@@ -125,7 +125,7 @@ 
                 'name'    => $addon->name(),
                 'version' => $addon->version(),
             );
-            $addons[ $addon_json['name'] ] = $addon_json;
+            $addons[$addon_json['name']] = $addon_json;
         }
         $response_data['ee'] = array(
             'version'              => EEM_System_Status::instance()->get_ee_version(),

core/libraries/rest_api/CalculatedModelFields.php

Indentation +112 added lines, -112 removed lines

@@ -19,124 +19,124 @@
 class CalculatedModelFields
 {
 
-    /**
-     * @var array
-     */
-    protected $mapping;
+	/**
+	 * @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 calculations
-     * 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->generateNewMapping();
-        }
-        return $this->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 calculations
+	 * 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->generateNewMapping();
+		}
+		return $this->mapping;
+	}
 
 
-    /**
-     * Generates  anew mapping between model calculated fields and their callbacks
-     *
-     * @return array
-     */
-    protected function generateNewMapping()
-    {
-        $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,
-                ),
-            )
-        );
-    }
+	/**
+	 * Generates  anew mapping between model calculated fields and their callbacks
+	 *
+	 * @return array
+	 */
+	protected function generateNewMapping()
+	{
+		$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 retrieveCalculatedFieldsForModel(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();
-        }
-    }
+	/**
+	 * Gets the known calculated fields for model
+	 *
+	 * @param EEM_Base $model
+	 * @return array allowable values for this field
+	 */
+	public function retrieveCalculatedFieldsForModel(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                                                $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 retrieveCalculatedFieldValue(
-        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 ];
-            $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
-            return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller);
-        }
-        throw new RestException(
-            '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()
-            )
-        );
-    }
+	/**
+	 * Retrieves the value for this calculation
+	 *
+	 * @param EEM_Base                                                $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 retrieveCalculatedFieldValue(
+		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 ];
+			$class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
+			return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller);
+		}
+		throw new RestException(
+			'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 +9 added lines, -9 removed lines

@@ -37,7 +37,7 @@ 
      */
     public function mapping($refresh = false)
     {
-        if (! $this->mapping || $refresh) {
+        if ( ! $this->mapping || $refresh) {
             $this->mapping = $this->generateNewMapping();
         }
         return $this->mapping;
@@ -52,9 +52,9 @@ 
     protected function generateNewMapping()
     {
         $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(
@@ -96,8 +96,8 @@ 
     public function retrieveCalculatedFieldsForModel(EEM_Base $model)
     {
         $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
+        if (isset($mapping[$model->get_this_model_name()])) {
+            return array_keys($mapping[$model->get_this_model_name()]);
         } else {
             return array();
         }
@@ -123,10 +123,10 @@ 
         Base $controller
     ) {
         $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])
-            && isset($mapping[ $model->get_this_model_name() ][ $field_name ])
+        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 ];
+            $classname = $mapping[$model->get_this_model_name()][$field_name];
             $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
             return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller);
         }

core/libraries/rest_api/changes/ChangesInBase.php

Indentation +64 added lines, -64 removed lines

@@ -35,74 +35,74 @@
 abstract class ChangesInBase
 {
 
-    /**
-     * The version that these changes happened
-     *
-     * @var string
-     */
-    protected $version = null;
+	/**
+	 * The version that these changes happened
+	 *
+	 * @var string
+	 */
+	protected $version = null;
 
 
-    /**
-     * Called when an EE4 REST API request is made to an earlier version than
-     * what is indicated in this class' name.
-     * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
-     * so that regardless of what version of EE4 core is running, API clients
-     * will have a consistent response
-     *
-     * @return void
-     */
-    abstract public function setHooks();
+	/**
+	 * Called when an EE4 REST API request is made to an earlier version than
+	 * what is indicated in this class' name.
+	 * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
+	 * so that regardless of what version of EE4 core is running, API clients
+	 * will have a consistent response
+	 *
+	 * @return void
+	 */
+	abstract public function setHooks();
 
 
-    /**
-     * Returns whether or not this class' name indicates its hooks should
-     * apply when a request comes in for $requested_version. A class can use
-     * other conditions when determining whether to perform their callbacks or not,
-     * but this will typically be enough
-     *
-     * @param string $requested_version eg "4.8.33"
-     * @return boolean true: this class' name indicates its filters and actions
-     *                                  should take effect. False: this class' name indicates it shouldn't do anything
-     */
-    public function appliesToVersion($requested_version)
-    {
-        if ($this->version() > $requested_version) {
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * Returns whether or not this class' name indicates its hooks should
+	 * apply when a request comes in for $requested_version. A class can use
+	 * other conditions when determining whether to perform their callbacks or not,
+	 * but this will typically be enough
+	 *
+	 * @param string $requested_version eg "4.8.33"
+	 * @return boolean true: this class' name indicates its filters and actions
+	 *                                  should take effect. False: this class' name indicates it shouldn't do anything
+	 */
+	public function appliesToVersion($requested_version)
+	{
+		if ($this->version() > $requested_version) {
+			return true;
+		}
+		return false;
+	}
 
 
-    /**
-     * Gets the EE core version when this changes were made to the rest api.
-     * Any requests to earlier versions should have modifications made to them
-     * by the callbacks of this class.
-     *
-     * @return string eg "4.8.33"
-     * @throws EE_Error
-     */
-    public function version()
-    {
-        if ($this->version === null) {
-            $matches = array();
-            $regex = '~ChangesIn(\d)(\d\d)(\d\d)$~';
-            $success = preg_match(
-                $regex,
-                get_class($this),
-                $matches
-            );
-            if (! $success) {
-                throw new EE_Error(
-                    sprintf(
-                        __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
-                        get_class($this),
-                        $regex
-                    )
-                );
-            }
-            $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
-        }
-        return $this->version;
-    }
+	/**
+	 * Gets the EE core version when this changes were made to the rest api.
+	 * Any requests to earlier versions should have modifications made to them
+	 * by the callbacks of this class.
+	 *
+	 * @return string eg "4.8.33"
+	 * @throws EE_Error
+	 */
+	public function version()
+	{
+		if ($this->version === null) {
+			$matches = array();
+			$regex = '~ChangesIn(\d)(\d\d)(\d\d)$~';
+			$success = preg_match(
+				$regex,
+				get_class($this),
+				$matches
+			);
+			if (! $success) {
+				throw new EE_Error(
+					sprintf(
+						__('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
+						get_class($this),
+						$regex
+					)
+				);
+			}
+			$this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
+		}
+		return $this->version;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -92,7 +92,7 @@ 
                 get_class($this),
                 $matches
             );
-            if (! $success) {
+            if ( ! $success) {
                 throw new EE_Error(
                     sprintf(
                         __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
@@ -101,7 +101,7 @@ 
                     )
                 );
             }
-            $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
+            $this->version = (int) $matches[1].'.'.(int) $matches[2].'.'.(int) $matches[3];
         }
         return $this->version;
     }

core/libraries/rest_api/changes/ChangesIn40836.php

Indentation +160 added lines, -160 removed lines

@@ -14,174 +14,174 @@
 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
-        );
-    }
+	/**
+	 * 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;
-    }
+	/**
+	 * 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 "_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;
-    }
+	/**
+	 * 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;
-    }
+	/**
+	 * 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;
-    }
+	/**
+	 * 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 +4 added lines, -4 removed lines

@@ -119,9 +119,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',
                     )
                 )
             );
@@ -151,7 +151,7 @@ 
             && $model instanceof \EEM_CPT_Base
         ) {
             $attachment = wp_get_attachment_image_src(
-                get_post_thumbnail_id($entity_response_array[ $model->primary_key_name() ]),
+                get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
                 'full'
             );
             $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;

core/libraries/rest_api/ModelVersionInfo.php

Indentation +436 added lines, -436 removed lines

@@ -21,440 +21,440 @@
 class ModelVersionInfo
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const MODEL_ADDED = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $cached_fields_on_models = array();
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->requested_version = (string) $requested_version;
-        $this->model_changes = array(
-            '4.8.29' => array(
-                // first version where the REST API is in EE core, so no need
-                // to specify how its different from the previous
-            ),
-        );
-        // setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function modelChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->modelChanges() as $version => $models_changed_in_version) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
-                }
-            }
-            $this->cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->cached_model_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resourceChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resourceChanges() as $version => $model_classnames) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
-                }
-            }
-            $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requestedVersion()
-    {
-        return $this->requested_version;
-    }
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function modelChanges()
-    {
-        return $this->model_changes;
-    }
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function modelsForRequestedVersion()
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
-                    }
-                }
-            }
-            $this->cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->cached_models_for_requested_version;
-    }
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function isModelNameInThisVersion($model_name)
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function loadModel($model_name)
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requestedVersion()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fieldsOnModelInThisVersion($model)
-    {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
-            // get all model changes between the requested version and current core version
-            $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
-            // fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            // remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
-                    );
-                }
-            }
-            $this->cached_fields_on_models = $current_fields;
-        }
-        return $this->cached_fields_on_models;
-    }
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldIsIgnored($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHaveRenderedFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasRenderedFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHavePrettyFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasPrettyFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
-    }
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resourceChanges()
-    {
-        return $this->resource_changes;
-    }
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extraResourcePropertiesForModel($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relationSettings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
-            }
-        }
-        // filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const MODEL_ADDED = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $cached_fields_on_models = array();
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->requested_version = (string) $requested_version;
+		$this->model_changes = array(
+			'4.8.29' => array(
+				// first version where the REST API is in EE core, so no need
+				// to specify how its different from the previous
+			),
+		);
+		// setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
+							$this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function modelChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->modelChanges() as $version => $models_changed_in_version) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$model_changes[ $version ] = $models_changed_in_version;
+				}
+			}
+			$this->cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->cached_model_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resourceChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resourceChanges() as $version => $model_classnames) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$resource_changes[ $version ] = $model_classnames;
+				}
+			}
+			$this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requestedVersion()
+	{
+		return $this->requested_version;
+	}
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function modelChanges()
+	{
+		return $this->model_changes;
+	}
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function modelsForRequestedVersion()
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
+						unset($all_models_in_current_version[ $model_name ]);
+					}
+				}
+			}
+			$this->cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->cached_models_for_requested_version;
+	}
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function isModelNameInThisVersion($model_name)
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		if (isset($model_names[ $model_name ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function loadModel($model_name)
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requestedVersion()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fieldsOnModelInThisVersion($model)
+	{
+		if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+			// get all model changes between the requested version and current core version
+			$changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
+			// fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			// remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (isset($changes_in_version[ $model->get_this_model_name() ])
+					&& $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[ $model->get_this_model_name() ])
+					);
+				}
+			}
+			$this->cached_fields_on_models = $current_fields;
+		}
+		return $this->cached_fields_on_models;
+	}
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldIsIgnored($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHaveRenderedFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasRenderedFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHavePrettyFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasPrettyFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
+	}
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resourceChanges()
+	{
+		return $this->resource_changes;
+	}
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extraResourcePropertiesForModel($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relationSettings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->isModelNameInThisVersion($relation_name)) {
+				$relations[ $relation_name ] = $relation_obj;
+			}
+		}
+		// filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -114,10 +114,10 @@ 
         foreach ($this->resource_changes as $version => $model_classnames) {
             foreach ($model_classnames as $model_classname => $extra_fields) {
                 foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+                    $this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+                        if ( ! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+                            $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
                 }
@@ -139,7 +139,7 @@ 
             $model_changes = array();
             foreach ($this->modelChanges() as $version => $models_changed_in_version) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
+                    $model_changes[$version] = $models_changed_in_version;
                 }
             }
             $this->cached_model_changes_between_requested_version_and_current = $model_changes;
@@ -161,7 +161,7 @@ 
             $resource_changes = array();
             foreach ($this->resourceChanges() as $version => $model_classnames) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
+                    $resource_changes[$version] = $model_classnames;
                 }
             }
             $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
@@ -212,7 +212,7 @@ 
             foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
                 foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
                     if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
+                        unset($all_models_in_current_version[$model_name]);
                     }
                 }
             }
@@ -237,7 +237,7 @@ 
     public function isModelNameInThisVersion($model_name)
     {
         $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
+        if (isset($model_names[$model_name])) {
             return true;
         } else {
             return false;
@@ -280,19 +280,19 @@ 
      */
     public function fieldsOnModelInThisVersion($model)
     {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+        if ( ! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
             // get all model changes between the requested version and current core version
             $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
             // fetch all fields currently on this model
             $current_fields = $model->field_settings();
             // remove all fields that have been added since
             foreach ($changes as $version => $changes_in_version) {
-                if (isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+                if (isset($changes_in_version[$model->get_this_model_name()])
+                    && $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
                 ) {
                     $current_fields = array_diff_key(
                         $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
+                        array_flip($changes_in_version[$model->get_this_model_name()])
                     );
                 }
             }
@@ -447,7 +447,7 @@ 
         $relations = array();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
+                $relations[$relation_name] = $relation_obj;
             }
         }
         // filter the results, but use the old filter name

core/libraries/rest_api/Capabilities.php

Indentation +140 added lines, -140 removed lines

@@ -15,152 +15,152 @@
 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;
-    }
+	/**
+	 * 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 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)));
-    }
+	/**
+	 * 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
-        );
-    }
+	/**
+	 * 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)
-            );
-        }
-    }
+	/**
+	 * 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)
+			);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -119,11 +119,11 @@ 
         }
         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'])
+                && isset($entity[$field_name])
+                && is_array($entity[$field_name])
+                && isset($entity[$field_name]['raw'])
             ) {
-                unset($entity[ $field_name ]['raw']);
+                unset($entity[$field_name]['raw']);
             }
         }
         // theoretically we may want to filter out specific fields for specific models
@@ -149,7 +149,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),