gravityview / GravityView

future/includes/rest/class-gv-rest-views-route.php

Indentation +509 added lines, -509 removed lines

@@ -14,520 +14,520 @@
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 class Views_Route extends Route
 {
-    /**
-     * Route Name.
-     *
-     * @since 2.0
-     *
-     * @string
-     */
-    protected $route_name = 'views';
-
-    /**
-     * Sub type, forms {$namespace}/route_name/{id}/sub_type type endpoints.
-     *
-     * @since 2.0
-     *
-     * @var string
-     */
-    protected $sub_type = 'entries';
-
-    /**
-     * Get a collection of views.
-     *
-     * Callback for GET /v1/views/
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_items($request)
-    {
-        $page = $request->get_param('page');
-        $limit = $request->get_param('limit');
-
-        $items = \GVCommon::get_all_views([
-            'posts_per_page' => $limit,
-            'paged'          => $page,
-        ]);
-
-        if (empty($items)) {
-            return new \WP_Error('gravityview-no-views', __('No Views found.', 'gravityview')); //@todo message
-        }
-
-        $data = [
-            'views' => [],
-            'total' => wp_count_posts('gravityview')->publish,
-        ];
-        foreach ($items as $item) {
-            $data['views'][] = $this->prepare_view_for_response($item, $request);
-        }
-
-        return new \WP_REST_Response($data, 200);
-    }
-
-    /**
-     * Get one view.
-     *
-     * Callback for /v1/views/{id}/
-     *
-     * @since 2.0
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_item($request)
-    {
-        $url = $request->get_url_params();
-
-        $view_id = intval($url['id']);
-
-        $item = get_post($view_id);
-
-        //return a response or error based on some conditional
-        if ($item && !is_wp_error($item)) {
-            $data = $this->prepare_view_for_response($item, $request);
-
-            return new \WP_REST_Response($data, 200);
-        }
-
-        return new \WP_Error('code', sprintf('A View with ID #%d was not found.', $view_id));
-    }
-
-    /**
-     * Prepare the item for the REST response.
-     *
-     * @since 2.0
-     *
-     * @param \GV\View         $view    The view.
-     * @param \GV\Entry        $entry   WordPress representation of the item.
-     * @param \WP_REST_Request $request Request object.
-     * @param string           $context The context (directory, single)
-     * @param string           $class   The value renderer. Default: null (raw value)
-     *
-     * @since 2.1 Add value renderer override $class parameter.
-     *
-     * @return mixed The data that is sent.
-     */
-    public function prepare_entry_for_response($view, $entry, \WP_REST_Request $request, $context, $class = null)
-    {
-
-        // Only output the fields that should be displayed.
-        $allowed = [];
-        foreach ($view->fields->by_position("{$context}_*")->by_visible($view)->all() as $field) {
-            $allowed[] = $field;
-        }
-
-        /**
-         * @filter `gravityview/rest/entry/fields` Allow more entry fields that are output in regular REST requests.
-         *
-         * @param array            $allowed The allowed ones, default by_visible, by_position( "context_*" ), i.e. as set in the view.
-         * @param \GV\View         $view    The view.
-         * @param \GV\Entry        $entry   The entry.
-         * @param \WP_REST_Request $request Request object.
-         * @param string           $context The context (directory, single)
-         */
-        $allowed_field_ids = apply_filters('gravityview/rest/entry/fields', wp_list_pluck($allowed, 'ID'), $view, $entry, $request, $context);
-
-        $allowed = array_filter($allowed, function ($field) use ($allowed_field_ids) {
-            return in_array($field->ID, $allowed_field_ids, true);
-        });
-
-        // Tack on additional fields if needed
-        foreach (array_diff($allowed_field_ids, wp_list_pluck($allowed, 'ID')) as $field_id) {
-            $allowed[] = is_numeric($field_id) ? \GV\GF_Field::by_id($view->form, $field_id) : \GV\Internal_Field::by_id($field_id);
-        }
-
-        $r = new Request($request);
-        $return = [];
-
-        $renderer = new \GV\Field_Renderer();
-
-        $used_ids = [];
-
-        foreach ($allowed as $field) {
-            $source = is_numeric($field->ID) ? $view->form : new \GV\Internal_Source();
-
-            $field_id = $field->ID;
-            $index = null;
-
-            if (!isset($used_ids[$field_id])) {
-                $used_ids[$field_id] = 0;
-            } else {
-                $index = ++$used_ids[$field_id];
-            }
-
-            if ($index) {
-                /**
-                 * Modify non-unique IDs (custom, id, etc.) to be unique and not gobbled up.
-                 */
-                $field_id = sprintf('%s(%d)', $field_id, $index + 1);
-            }
-
-            /**
-             * @filter `gravityview/api/field/key` Filter the key name in the results for JSON output.
-             *
-             * @param string           $field_id The ID. Should be unique or keys will be gobbled up.
-             * @param \GV\View         $view     The view.
-             * @param \GV\Entry        $entry    The entry.
-             * @param \WP_REST_Request $request  Request object.
-             * @param string           $context  The context (directory, single)
-             */
-            $field_id = apply_filters('gravityview/api/field/key', $field_id, $view, $entry, $request, $context);
-
-            if (!$class && in_array($field->ID, ['custom'])) {
-                /**
-                 * Custom fields (and perhaps some others) will require rendering as they don't
-                 * contain an intrinsic value (for custom their value is stored in the view and requires a renderer).
-                 * We force the CSV template to take over in such cases, it's good enough for most cases.
-                 */
-                $return[$field_id] = $renderer->render($field, $view, $source, $entry, $r, '\GV\Field_CSV_Template');
-            } elseif ($class) {
-                $return[$field_id] = $renderer->render($field, $view, $source, $entry, $r, $class);
-            } else {
-                switch ($field->type) {
-                    case 'list':
-                        $return[$field_id] = unserialize($field->get_value($view, $source, $entry, $r));
-                        break;
-                    case 'fileupload':
-                    case 'business_hours':
-                        $return[$field_id] = json_decode($field->get_value($view, $source, $entry, $r));
-                        break;
-                    default:
-                        $return[$field_id] = $field->get_value($view, $source, $entry, $r);
-                }
-            }
-        }
-
-        return $return;
-    }
-
-    /**
-     * Get entries from a view.
-     *
-     * Callback for /v1/views/{id}/entries/
-     *
-     * @since 2.0
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_sub_items($request)
-    {
-        $url = $request->get_url_params();
-        $view_id = intval($url['id']);
-        $format = \GV\Utils::get($url, 'format', 'json');
-
-        if ($post_id = $request->get_param('post_id')) {
-            global $post;
-
-            $post = get_post($post_id);
-
-            if (!$post || is_wp_error($post)) {
-                return new \WP_Error('gravityview-post-not-found', sprintf('A post with ID #%d was not found.', $post_id));
-            }
-
-            $collection = \GV\View_Collection::from_post($post);
-
-            if (!$collection->contains($view_id)) {
-                return new \WP_Error('gravityview-post-not-contains', sprintf('The post with ID #%d does not contain a View with ID #%d', $post_id, $view_id));
-            }
-        }
-
-        $view = \GV\View::by_id($view_id);
-
-        if ('html' === $format) {
-            $renderer = new \GV\View_Renderer();
-            $count = $total = 0;
-
-            /** @var \GV\Template_Context $context */
-            add_action('gravityview/template/view/render', function ($context) use (&$count, &$total) {
-                $count = $context->entries->count();
-                $total = $context->entries->total();
-            });
-
-            $output = $renderer->render($view, new Request($request));
-
-            /**
-             * @filter `gravityview/rest/entries/html/insert_meta` Whether to include `http-equiv` meta tags in the HTML output describing the data
-             *
-             * @since 2.0
-             *
-             * @param bool             $insert_meta Add <meta> tags? [Default: true]
-             * @param int              $count       The number of entries being rendered
-             * @param \GV\View         $view        The view.
-             * @param \WP_REST_Request $request     Request object.
-             * @param int              $total       The number of total entries for the request
-             */
-            $insert_meta = apply_filters('gravityview/rest/entries/html/insert_meta', true, $count, $view, $request, $total);
-
-            if ($insert_meta) {
-                $output = '<meta http-equiv="X-Item-Count" content="'.$count.'" />'.$output;
-                $output = '<meta http-equiv="X-Item-Total" content="'.$total.'" />'.$output;
-            }
-
-            $response = new \WP_REST_Response($output, 200);
-            $response->header('X-Item-Count', $count);
-            $response->header('X-Item-Total', $total);
-
-            return $response;
-        }
-
-        $entries = $view->get_entries(new Request($request));
-
-        if (!$entries->all()) {
-            return new \WP_Error('gravityview-no-entries', __('No Entries found.', 'gravityview'));
-        }
-
-        if (in_array($format, ['csv', 'tsv'], true)) {
-            ob_start();
-
-            $csv_or_tsv = fopen('php://output', 'w');
-
-            /** Da' BOM :) */
-            if (apply_filters('gform_include_bom_export_entries', true, $view->form ? $view->form->form : null)) {
-                fputs($csv_or_tsv, "\xef\xbb\xbf");
-            }
-
-            $headers_done = false;
-
-            // If not "tsv" then use comma
-            $delimiter = ('tsv' === $format) ? "\t" : ',';
-
-            foreach ($entries->all() as $entry) {
-                $entry = $this->prepare_entry_for_response($view, $entry, $request, 'directory', '\GV\Field_CSV_Template');
-
-                if (!$headers_done) {
-                    $headers_done = fputcsv($csv_or_tsv, array_map(['\GV\Utils', 'strip_excel_formulas'], array_keys($entry)), $delimiter);
-                }
-
-                fputcsv($csv_or_tsv, array_map(['\GV\Utils', 'strip_excel_formulas'], $entry), $delimiter);
-            }
-
-            $response = new \WP_REST_Response('', 200);
-            $response->header('X-Item-Count', $entries->count());
-            $response->header('X-Item-Total', $entries->total());
-            $response->header('Content-Type', 'text/'.$format);
-
-            fflush($csv_or_tsv);
-
-            $data = rtrim(ob_get_clean());
-
-            add_filter('rest_pre_serve_request', function () use ($data) {
-                echo $data;
+	/**
+	 * Route Name.
+	 *
+	 * @since 2.0
+	 *
+	 * @string
+	 */
+	protected $route_name = 'views';
+
+	/**
+	 * Sub type, forms {$namespace}/route_name/{id}/sub_type type endpoints.
+	 *
+	 * @since 2.0
+	 *
+	 * @var string
+	 */
+	protected $sub_type = 'entries';
+
+	/**
+	 * Get a collection of views.
+	 *
+	 * Callback for GET /v1/views/
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_items($request)
+	{
+		$page = $request->get_param('page');
+		$limit = $request->get_param('limit');
+
+		$items = \GVCommon::get_all_views([
+			'posts_per_page' => $limit,
+			'paged'          => $page,
+		]);
+
+		if (empty($items)) {
+			return new \WP_Error('gravityview-no-views', __('No Views found.', 'gravityview')); //@todo message
+		}
+
+		$data = [
+			'views' => [],
+			'total' => wp_count_posts('gravityview')->publish,
+		];
+		foreach ($items as $item) {
+			$data['views'][] = $this->prepare_view_for_response($item, $request);
+		}
+
+		return new \WP_REST_Response($data, 200);
+	}
+
+	/**
+	 * Get one view.
+	 *
+	 * Callback for /v1/views/{id}/
+	 *
+	 * @since 2.0
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_item($request)
+	{
+		$url = $request->get_url_params();
+
+		$view_id = intval($url['id']);
+
+		$item = get_post($view_id);
+
+		//return a response or error based on some conditional
+		if ($item && !is_wp_error($item)) {
+			$data = $this->prepare_view_for_response($item, $request);
+
+			return new \WP_REST_Response($data, 200);
+		}
+
+		return new \WP_Error('code', sprintf('A View with ID #%d was not found.', $view_id));
+	}
+
+	/**
+	 * Prepare the item for the REST response.
+	 *
+	 * @since 2.0
+	 *
+	 * @param \GV\View         $view    The view.
+	 * @param \GV\Entry        $entry   WordPress representation of the item.
+	 * @param \WP_REST_Request $request Request object.
+	 * @param string           $context The context (directory, single)
+	 * @param string           $class   The value renderer. Default: null (raw value)
+	 *
+	 * @since 2.1 Add value renderer override $class parameter.
+	 *
+	 * @return mixed The data that is sent.
+	 */
+	public function prepare_entry_for_response($view, $entry, \WP_REST_Request $request, $context, $class = null)
+	{
+
+		// Only output the fields that should be displayed.
+		$allowed = [];
+		foreach ($view->fields->by_position("{$context}_*")->by_visible($view)->all() as $field) {
+			$allowed[] = $field;
+		}
+
+		/**
+		 * @filter `gravityview/rest/entry/fields` Allow more entry fields that are output in regular REST requests.
+		 *
+		 * @param array            $allowed The allowed ones, default by_visible, by_position( "context_*" ), i.e. as set in the view.
+		 * @param \GV\View         $view    The view.
+		 * @param \GV\Entry        $entry   The entry.
+		 * @param \WP_REST_Request $request Request object.
+		 * @param string           $context The context (directory, single)
+		 */
+		$allowed_field_ids = apply_filters('gravityview/rest/entry/fields', wp_list_pluck($allowed, 'ID'), $view, $entry, $request, $context);
+
+		$allowed = array_filter($allowed, function ($field) use ($allowed_field_ids) {
+			return in_array($field->ID, $allowed_field_ids, true);
+		});
+
+		// Tack on additional fields if needed
+		foreach (array_diff($allowed_field_ids, wp_list_pluck($allowed, 'ID')) as $field_id) {
+			$allowed[] = is_numeric($field_id) ? \GV\GF_Field::by_id($view->form, $field_id) : \GV\Internal_Field::by_id($field_id);
+		}
+
+		$r = new Request($request);
+		$return = [];
+
+		$renderer = new \GV\Field_Renderer();
+
+		$used_ids = [];
+
+		foreach ($allowed as $field) {
+			$source = is_numeric($field->ID) ? $view->form : new \GV\Internal_Source();
+
+			$field_id = $field->ID;
+			$index = null;
+
+			if (!isset($used_ids[$field_id])) {
+				$used_ids[$field_id] = 0;
+			} else {
+				$index = ++$used_ids[$field_id];
+			}
+
+			if ($index) {
+				/**
+				 * Modify non-unique IDs (custom, id, etc.) to be unique and not gobbled up.
+				 */
+				$field_id = sprintf('%s(%d)', $field_id, $index + 1);
+			}
+
+			/**
+			 * @filter `gravityview/api/field/key` Filter the key name in the results for JSON output.
+			 *
+			 * @param string           $field_id The ID. Should be unique or keys will be gobbled up.
+			 * @param \GV\View         $view     The view.
+			 * @param \GV\Entry        $entry    The entry.
+			 * @param \WP_REST_Request $request  Request object.
+			 * @param string           $context  The context (directory, single)
+			 */
+			$field_id = apply_filters('gravityview/api/field/key', $field_id, $view, $entry, $request, $context);
+
+			if (!$class && in_array($field->ID, ['custom'])) {
+				/**
+				 * Custom fields (and perhaps some others) will require rendering as they don't
+				 * contain an intrinsic value (for custom their value is stored in the view and requires a renderer).
+				 * We force the CSV template to take over in such cases, it's good enough for most cases.
+				 */
+				$return[$field_id] = $renderer->render($field, $view, $source, $entry, $r, '\GV\Field_CSV_Template');
+			} elseif ($class) {
+				$return[$field_id] = $renderer->render($field, $view, $source, $entry, $r, $class);
+			} else {
+				switch ($field->type) {
+					case 'list':
+						$return[$field_id] = unserialize($field->get_value($view, $source, $entry, $r));
+						break;
+					case 'fileupload':
+					case 'business_hours':
+						$return[$field_id] = json_decode($field->get_value($view, $source, $entry, $r));
+						break;
+					default:
+						$return[$field_id] = $field->get_value($view, $source, $entry, $r);
+				}
+			}
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Get entries from a view.
+	 *
+	 * Callback for /v1/views/{id}/entries/
+	 *
+	 * @since 2.0
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_sub_items($request)
+	{
+		$url = $request->get_url_params();
+		$view_id = intval($url['id']);
+		$format = \GV\Utils::get($url, 'format', 'json');
+
+		if ($post_id = $request->get_param('post_id')) {
+			global $post;
+
+			$post = get_post($post_id);
+
+			if (!$post || is_wp_error($post)) {
+				return new \WP_Error('gravityview-post-not-found', sprintf('A post with ID #%d was not found.', $post_id));
+			}
+
+			$collection = \GV\View_Collection::from_post($post);
+
+			if (!$collection->contains($view_id)) {
+				return new \WP_Error('gravityview-post-not-contains', sprintf('The post with ID #%d does not contain a View with ID #%d', $post_id, $view_id));
+			}
+		}
+
+		$view = \GV\View::by_id($view_id);
+
+		if ('html' === $format) {
+			$renderer = new \GV\View_Renderer();
+			$count = $total = 0;
+
+			/** @var \GV\Template_Context $context */
+			add_action('gravityview/template/view/render', function ($context) use (&$count, &$total) {
+				$count = $context->entries->count();
+				$total = $context->entries->total();
+			});
+
+			$output = $renderer->render($view, new Request($request));
+
+			/**
+			 * @filter `gravityview/rest/entries/html/insert_meta` Whether to include `http-equiv` meta tags in the HTML output describing the data
+			 *
+			 * @since 2.0
+			 *
+			 * @param bool             $insert_meta Add <meta> tags? [Default: true]
+			 * @param int              $count       The number of entries being rendered
+			 * @param \GV\View         $view        The view.
+			 * @param \WP_REST_Request $request     Request object.
+			 * @param int              $total       The number of total entries for the request
+			 */
+			$insert_meta = apply_filters('gravityview/rest/entries/html/insert_meta', true, $count, $view, $request, $total);
+
+			if ($insert_meta) {
+				$output = '<meta http-equiv="X-Item-Count" content="'.$count.'" />'.$output;
+				$output = '<meta http-equiv="X-Item-Total" content="'.$total.'" />'.$output;
+			}
+
+			$response = new \WP_REST_Response($output, 200);
+			$response->header('X-Item-Count', $count);
+			$response->header('X-Item-Total', $total);
+
+			return $response;
+		}
+
+		$entries = $view->get_entries(new Request($request));
+
+		if (!$entries->all()) {
+			return new \WP_Error('gravityview-no-entries', __('No Entries found.', 'gravityview'));
+		}
+
+		if (in_array($format, ['csv', 'tsv'], true)) {
+			ob_start();
+
+			$csv_or_tsv = fopen('php://output', 'w');
+
+			/** Da' BOM :) */
+			if (apply_filters('gform_include_bom_export_entries', true, $view->form ? $view->form->form : null)) {
+				fputs($csv_or_tsv, "\xef\xbb\xbf");
+			}
+
+			$headers_done = false;
+
+			// If not "tsv" then use comma
+			$delimiter = ('tsv' === $format) ? "\t" : ',';
+
+			foreach ($entries->all() as $entry) {
+				$entry = $this->prepare_entry_for_response($view, $entry, $request, 'directory', '\GV\Field_CSV_Template');
+
+				if (!$headers_done) {
+					$headers_done = fputcsv($csv_or_tsv, array_map(['\GV\Utils', 'strip_excel_formulas'], array_keys($entry)), $delimiter);
+				}
+
+				fputcsv($csv_or_tsv, array_map(['\GV\Utils', 'strip_excel_formulas'], $entry), $delimiter);
+			}
+
+			$response = new \WP_REST_Response('', 200);
+			$response->header('X-Item-Count', $entries->count());
+			$response->header('X-Item-Total', $entries->total());
+			$response->header('Content-Type', 'text/'.$format);
+
+			fflush($csv_or_tsv);
+
+			$data = rtrim(ob_get_clean());
+
+			add_filter('rest_pre_serve_request', function () use ($data) {
+				echo $data;
 
-                return true;
-            });
+				return true;
+			});
 
-            if (defined('DOING_GRAVITYVIEW_TESTS') && DOING_GRAVITYVIEW_TESTS) {
-                echo $data; // rest_pre_serve_request is not called in tests
-            }
+			if (defined('DOING_GRAVITYVIEW_TESTS') && DOING_GRAVITYVIEW_TESTS) {
+				echo $data; // rest_pre_serve_request is not called in tests
+			}
 
-            return $response;
-        }
-
-        $data = ['entries' => $entries->all(), 'total' => $entries->total()];
-
-        foreach ($data['entries'] as &$entry) {
-            $entry = $this->prepare_entry_for_response($view, $entry, $request, 'directory');
-        }
-
-        return new \WP_REST_Response($data, 200);
-    }
-
-    /**
-     * Get one entry from view.
-     *
-     * Callback for /v1/views/{id}/entries/{id}/
-     *
-     * @uses GVCommon::get_entry
-     *
-     * @since 2.0
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_sub_item($request)
-    {
-        $url = $request->get_url_params();
-        $view_id = intval($url['id']);
-        $entry_id = intval($url['s_id']);
-        $format = \GV\Utils::get($url, 'format', 'json');
-
-        $view = \GV\View::by_id($view_id);
-        $entry = \GV\GF_Entry::by_id($entry_id);
-
-        if ($format === 'html') {
-            $renderer = new \GV\Entry_Renderer();
-
-            return $renderer->render($entry, $view, new Request($request));
-        }
-
-        return $this->prepare_entry_for_response($view, $entry, $request, 'single');
-    }
-
-    /**
-     * Prepare the item for the REST response.
-     *
-     * @since 2.0
-     *
-     * @param \WP_Post         $view_post WordPress representation of the item.
-     * @param \WP_REST_Request $request   Request object.
-     *
-     * @return mixed
-     */
-    public function prepare_view_for_response($view_post, \WP_REST_Request $request)
-    {
-        if (is_wp_error($this->get_item_permissions_check($request, $view_post->ID))) {
-            // Redacted out view.
-            return ['ID' => $view_post->ID, 'post_content' => __('You are not allowed to access this content.', 'gravityview')];
-        }
-
-        $view = \GV\View::from_post($view_post);
-
-        $item = $view->as_data();
-
-        // Add all the WP_Post data
-        $view_post = $view_post->to_array();
-
-        unset($view_post['to_ping'], $view_post['ping_status'], $view_post['pinged'], $view_post['post_type'], $view_post['filter'], $view_post['post_category'], $view_post['tags_input'], $view_post['post_content'], $view_post['post_content_filtered']);
-
-        $return = wp_parse_args($item, $view_post);
-
-        $return['title'] = $return['post_title'];
-
-        $return['settings'] = isset($return['atts']) ? $return['atts'] : [];
-        unset($return['atts'], $return['view_id']);
-
-        $return['search_criteria'] = [
-            'page_size'      => rgars($return, 'settings/page_size'),
-            'sort_field'     => rgars($return, 'settings/sort_field'),
-            'sort_direction' => rgars($return, 'settings/sort_direction'),
-            'offset'         => rgars($return, 'settings/offset'),
-        ];
-
-        unset($return['settings']['page_size'], $return['settings']['sort_field'], $return['settings']['sort_direction']);
-
-        // Redact for non-logged ins
-        if (!\GVCommon::has_cap('edit_others_gravityviews')) {
-            unset($return['settings']);
-            unset($return['search_criteria']);
-        }
-
-        if (!\GFCommon::current_user_can_any('gravityforms_edit_forms')) {
-            unset($return['form']);
-        }
-
-        return $return;
-    }
-
-    /**
-     * @param \WP_REST_Request $request
-     *
-     * @return bool|\WP_Error
-     */
-    public function get_item_permissions_check($request)
-    {
-        if (func_num_args() === 2) {
-            $view_id = func_get_arg(1); // $view_id override
-        } else {
-            $url = $request->get_url_params();
-            $view_id = intval($url['id']);
-        }
-
-        if (!$view = \GV\View::by_id($view_id)) {
-            return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
-        }
-
-        while ($error = $view->can_render(['rest'], $request)) {
-            if (!is_wp_error($error)) {
-                break;
-            }
-
-            switch (str_replace('gravityview/', '', $error->get_error_code())) {
-                case 'rest_disabled':
-                case 'post_password_required':
-                case 'not_public':
-                case 'embed_only':
-                case 'no_direct_access':
-                    return new \WP_Error('rest_forbidden_access_denied', __('You are not allowed to access this content.', 'gravityview'));
-                case 'no_form_attached':
-                    return new \WP_Error('rest_forbidden_no_form_attached', __('This View is not configured properly.', 'gravityview'));
-                default:
-                    return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
-            }
-        }
-
-        /**
-         * @filter `gravityview/view/output/rest` Disable rest output. Final chance.
-         *
-         * @param bool Enable or not.
-         * @param \GV\View $view The view.
-         */
-        if (!apply_filters('gravityview/view/output/rest', true, $view)) {
-            return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
-        }
-
-        return true;
-    }
-
-    public function get_sub_item_permissions_check($request)
-    {
-        // Accessing a single entry needs the View access permissions.
-        if (is_wp_error($error = $this->get_items_permissions_check($request))) {
-            return $error;
-        }
-
-        $url = $request->get_url_params();
-        $view_id = intval($url['id']);
-        $entry_id = intval($url['s_id']);
-
-        $view = \GV\View::by_id($view_id);
-
-        if (!$entry = \GV\GF_Entry::by_id($entry_id)) {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
-        }
-
-        if ($entry['form_id'] != $view->form->ID) {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
-        }
-
-        if ($entry['status'] != 'active') {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
-        }
-
-        if (apply_filters('gravityview_custom_entry_slug', false) && $entry->slug != get_query_var(\GV\Entry::get_endpoint_name())) {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
-        }
-
-        $is_admin_and_can_view = $view->settings->get('admin_show_all_statuses') && \GVCommon::has_cap('gravityview_moderate_entries', $view->ID);
-
-        if ($view->settings->get('show_only_approved') && !$is_admin_and_can_view) {
-            if (!\GravityView_Entry_Approval_Status::is_approved(gform_get_meta($entry->ID, \GravityView_Entry_Approval::meta_key))) {
-                return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
-            }
-        }
-
-        return true;
-    }
-
-    public function get_items_permissions_check($request)
-    {
-        // Getting a list of all Views is always possible.
-        return true;
-    }
-
-    public function get_sub_items_permissions_check($request)
-    {
-        // Accessing all entries of a View needs the same permissions as accessing the View.
-        return $this->get_item_permissions_check($request);
-    }
+			return $response;
+		}
+
+		$data = ['entries' => $entries->all(), 'total' => $entries->total()];
+
+		foreach ($data['entries'] as &$entry) {
+			$entry = $this->prepare_entry_for_response($view, $entry, $request, 'directory');
+		}
+
+		return new \WP_REST_Response($data, 200);
+	}
+
+	/**
+	 * Get one entry from view.
+	 *
+	 * Callback for /v1/views/{id}/entries/{id}/
+	 *
+	 * @uses GVCommon::get_entry
+	 *
+	 * @since 2.0
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_sub_item($request)
+	{
+		$url = $request->get_url_params();
+		$view_id = intval($url['id']);
+		$entry_id = intval($url['s_id']);
+		$format = \GV\Utils::get($url, 'format', 'json');
+
+		$view = \GV\View::by_id($view_id);
+		$entry = \GV\GF_Entry::by_id($entry_id);
+
+		if ($format === 'html') {
+			$renderer = new \GV\Entry_Renderer();
+
+			return $renderer->render($entry, $view, new Request($request));
+		}
+
+		return $this->prepare_entry_for_response($view, $entry, $request, 'single');
+	}
+
+	/**
+	 * Prepare the item for the REST response.
+	 *
+	 * @since 2.0
+	 *
+	 * @param \WP_Post         $view_post WordPress representation of the item.
+	 * @param \WP_REST_Request $request   Request object.
+	 *
+	 * @return mixed
+	 */
+	public function prepare_view_for_response($view_post, \WP_REST_Request $request)
+	{
+		if (is_wp_error($this->get_item_permissions_check($request, $view_post->ID))) {
+			// Redacted out view.
+			return ['ID' => $view_post->ID, 'post_content' => __('You are not allowed to access this content.', 'gravityview')];
+		}
+
+		$view = \GV\View::from_post($view_post);
+
+		$item = $view->as_data();
+
+		// Add all the WP_Post data
+		$view_post = $view_post->to_array();
+
+		unset($view_post['to_ping'], $view_post['ping_status'], $view_post['pinged'], $view_post['post_type'], $view_post['filter'], $view_post['post_category'], $view_post['tags_input'], $view_post['post_content'], $view_post['post_content_filtered']);
+
+		$return = wp_parse_args($item, $view_post);
+
+		$return['title'] = $return['post_title'];
+
+		$return['settings'] = isset($return['atts']) ? $return['atts'] : [];
+		unset($return['atts'], $return['view_id']);
+
+		$return['search_criteria'] = [
+			'page_size'      => rgars($return, 'settings/page_size'),
+			'sort_field'     => rgars($return, 'settings/sort_field'),
+			'sort_direction' => rgars($return, 'settings/sort_direction'),
+			'offset'         => rgars($return, 'settings/offset'),
+		];
+
+		unset($return['settings']['page_size'], $return['settings']['sort_field'], $return['settings']['sort_direction']);
+
+		// Redact for non-logged ins
+		if (!\GVCommon::has_cap('edit_others_gravityviews')) {
+			unset($return['settings']);
+			unset($return['search_criteria']);
+		}
+
+		if (!\GFCommon::current_user_can_any('gravityforms_edit_forms')) {
+			unset($return['form']);
+		}
+
+		return $return;
+	}
+
+	/**
+	 * @param \WP_REST_Request $request
+	 *
+	 * @return bool|\WP_Error
+	 */
+	public function get_item_permissions_check($request)
+	{
+		if (func_num_args() === 2) {
+			$view_id = func_get_arg(1); // $view_id override
+		} else {
+			$url = $request->get_url_params();
+			$view_id = intval($url['id']);
+		}
+
+		if (!$view = \GV\View::by_id($view_id)) {
+			return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
+		}
+
+		while ($error = $view->can_render(['rest'], $request)) {
+			if (!is_wp_error($error)) {
+				break;
+			}
+
+			switch (str_replace('gravityview/', '', $error->get_error_code())) {
+				case 'rest_disabled':
+				case 'post_password_required':
+				case 'not_public':
+				case 'embed_only':
+				case 'no_direct_access':
+					return new \WP_Error('rest_forbidden_access_denied', __('You are not allowed to access this content.', 'gravityview'));
+				case 'no_form_attached':
+					return new \WP_Error('rest_forbidden_no_form_attached', __('This View is not configured properly.', 'gravityview'));
+				default:
+					return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
+			}
+		}
+
+		/**
+		 * @filter `gravityview/view/output/rest` Disable rest output. Final chance.
+		 *
+		 * @param bool Enable or not.
+		 * @param \GV\View $view The view.
+		 */
+		if (!apply_filters('gravityview/view/output/rest', true, $view)) {
+			return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
+		}
+
+		return true;
+	}
+
+	public function get_sub_item_permissions_check($request)
+	{
+		// Accessing a single entry needs the View access permissions.
+		if (is_wp_error($error = $this->get_items_permissions_check($request))) {
+			return $error;
+		}
+
+		$url = $request->get_url_params();
+		$view_id = intval($url['id']);
+		$entry_id = intval($url['s_id']);
+
+		$view = \GV\View::by_id($view_id);
+
+		if (!$entry = \GV\GF_Entry::by_id($entry_id)) {
+			return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+		}
+
+		if ($entry['form_id'] != $view->form->ID) {
+			return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+		}
+
+		if ($entry['status'] != 'active') {
+			return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+		}
+
+		if (apply_filters('gravityview_custom_entry_slug', false) && $entry->slug != get_query_var(\GV\Entry::get_endpoint_name())) {
+			return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+		}
+
+		$is_admin_and_can_view = $view->settings->get('admin_show_all_statuses') && \GVCommon::has_cap('gravityview_moderate_entries', $view->ID);
+
+		if ($view->settings->get('show_only_approved') && !$is_admin_and_can_view) {
+			if (!\GravityView_Entry_Approval_Status::is_approved(gform_get_meta($entry->ID, \GravityView_Entry_Approval::meta_key))) {
+				return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+			}
+		}
+
+		return true;
+	}
+
+	public function get_items_permissions_check($request)
+	{
+		// Getting a list of all Views is always possible.
+		return true;
+	}
+
+	public function get_sub_items_permissions_check($request)
+	{
+		// Accessing all entries of a View needs the same permissions as accessing the View.
+		return $this->get_item_permissions_check($request);
+	}
 }

Spacing +157 added lines, -157 removed lines

@@ -13,7 +13,7 @@ 
 namespace GV\REST;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -46,29 +46,29 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_items($request)
+    public function get_items( $request )
     {
-        $page = $request->get_param('page');
-        $limit = $request->get_param('limit');
+        $page = $request->get_param( 'page' );
+        $limit = $request->get_param( 'limit' );
 
-        $items = \GVCommon::get_all_views([
+        $items = \GVCommon::get_all_views( [
             'posts_per_page' => $limit,
             'paged'          => $page,
-        ]);
+        ] );
 
-        if (empty($items)) {
-            return new \WP_Error('gravityview-no-views', __('No Views found.', 'gravityview')); //@todo message
+        if ( empty( $items ) ) {
+            return new \WP_Error( 'gravityview-no-views', __( 'No Views found.', 'gravityview' ) ); //@todo message
         }
 
         $data = [
-            'views' => [],
-            'total' => wp_count_posts('gravityview')->publish,
+            'views' => [ ],
+            'total' => wp_count_posts( 'gravityview' )->publish,
         ];
-        foreach ($items as $item) {
-            $data['views'][] = $this->prepare_view_for_response($item, $request);
+        foreach ( $items as $item ) {
+            $data[ 'views' ][ ] = $this->prepare_view_for_response( $item, $request );
         }
 
-        return new \WP_REST_Response($data, 200);
+        return new \WP_REST_Response( $data, 200 );
     }
 
     /**
@@ -82,22 +82,22 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_item($request)
+    public function get_item( $request )
     {
         $url = $request->get_url_params();
 
-        $view_id = intval($url['id']);
+        $view_id = intval( $url[ 'id' ] );
 
-        $item = get_post($view_id);
+        $item = get_post( $view_id );
 
         //return a response or error based on some conditional
-        if ($item && !is_wp_error($item)) {
-            $data = $this->prepare_view_for_response($item, $request);
+        if ( $item && ! is_wp_error( $item ) ) {
+            $data = $this->prepare_view_for_response( $item, $request );
 
-            return new \WP_REST_Response($data, 200);
+            return new \WP_REST_Response( $data, 200 );
         }
 
-        return new \WP_Error('code', sprintf('A View with ID #%d was not found.', $view_id));
+        return new \WP_Error( 'code', sprintf( 'A View with ID #%d was not found.', $view_id ) );
     }
 
     /**
@@ -115,13 +115,13 @@ 
      *
      * @return mixed The data that is sent.
      */
-    public function prepare_entry_for_response($view, $entry, \WP_REST_Request $request, $context, $class = null)
+    public function prepare_entry_for_response( $view, $entry, \WP_REST_Request $request, $context, $class = null )
     {
 
         // Only output the fields that should be displayed.
-        $allowed = [];
-        foreach ($view->fields->by_position("{$context}_*")->by_visible($view)->all() as $field) {
-            $allowed[] = $field;
+        $allowed = [ ];
+        foreach ( $view->fields->by_position( "{$context}_*" )->by_visible( $view )->all() as $field ) {
+            $allowed[ ] = $field;
         }
 
         /**
@@ -133,41 +133,41 @@ 
          * @param \WP_REST_Request $request Request object.
          * @param string           $context The context (directory, single)
          */
-        $allowed_field_ids = apply_filters('gravityview/rest/entry/fields', wp_list_pluck($allowed, 'ID'), $view, $entry, $request, $context);
+        $allowed_field_ids = apply_filters( 'gravityview/rest/entry/fields', wp_list_pluck( $allowed, 'ID' ), $view, $entry, $request, $context );
 
-        $allowed = array_filter($allowed, function ($field) use ($allowed_field_ids) {
-            return in_array($field->ID, $allowed_field_ids, true);
+        $allowed = array_filter( $allowed, function( $field ) use ( $allowed_field_ids ) {
+            return in_array( $field->ID, $allowed_field_ids, true );
         });
 
         // Tack on additional fields if needed
-        foreach (array_diff($allowed_field_ids, wp_list_pluck($allowed, 'ID')) as $field_id) {
-            $allowed[] = is_numeric($field_id) ? \GV\GF_Field::by_id($view->form, $field_id) : \GV\Internal_Field::by_id($field_id);
+        foreach ( array_diff( $allowed_field_ids, wp_list_pluck( $allowed, 'ID' ) ) as $field_id ) {
+            $allowed[ ] = is_numeric( $field_id ) ? \GV\GF_Field::by_id( $view->form, $field_id ) : \GV\Internal_Field::by_id( $field_id );
         }
 
-        $r = new Request($request);
-        $return = [];
+        $r = new Request( $request );
+        $return = [ ];
 
         $renderer = new \GV\Field_Renderer();
 
-        $used_ids = [];
+        $used_ids = [ ];
 
-        foreach ($allowed as $field) {
-            $source = is_numeric($field->ID) ? $view->form : new \GV\Internal_Source();
+        foreach ( $allowed as $field ) {
+            $source = is_numeric( $field->ID ) ? $view->form : new \GV\Internal_Source();
 
             $field_id = $field->ID;
             $index = null;
 
-            if (!isset($used_ids[$field_id])) {
-                $used_ids[$field_id] = 0;
+            if ( ! isset( $used_ids[ $field_id ] ) ) {
+                $used_ids[ $field_id ] = 0;
             } else {
-                $index = ++$used_ids[$field_id];
+                $index = ++$used_ids[ $field_id ];
             }
 
-            if ($index) {
+            if ( $index ) {
                 /**
                  * Modify non-unique IDs (custom, id, etc.) to be unique and not gobbled up.
                  */
-                $field_id = sprintf('%s(%d)', $field_id, $index + 1);
+                $field_id = sprintf( '%s(%d)', $field_id, $index + 1 );
             }
 
             /**
@@ -179,28 +179,28 @@ 
              * @param \WP_REST_Request $request  Request object.
              * @param string           $context  The context (directory, single)
              */
-            $field_id = apply_filters('gravityview/api/field/key', $field_id, $view, $entry, $request, $context);
+            $field_id = apply_filters( 'gravityview/api/field/key', $field_id, $view, $entry, $request, $context );
 
-            if (!$class && in_array($field->ID, ['custom'])) {
+            if ( ! $class && in_array( $field->ID, [ 'custom' ] ) ) {
                 /**
                  * Custom fields (and perhaps some others) will require rendering as they don't
                  * contain an intrinsic value (for custom their value is stored in the view and requires a renderer).
                  * We force the CSV template to take over in such cases, it's good enough for most cases.
                  */
-                $return[$field_id] = $renderer->render($field, $view, $source, $entry, $r, '\GV\Field_CSV_Template');
-            } elseif ($class) {
-                $return[$field_id] = $renderer->render($field, $view, $source, $entry, $r, $class);
+                $return[ $field_id ] = $renderer->render( $field, $view, $source, $entry, $r, '\GV\Field_CSV_Template' );
+            } elseif ( $class ) {
+                $return[ $field_id ] = $renderer->render( $field, $view, $source, $entry, $r, $class );
             } else {
-                switch ($field->type) {
+                switch ( $field->type ) {
                     case 'list':
-                        $return[$field_id] = unserialize($field->get_value($view, $source, $entry, $r));
+                        $return[ $field_id ] = unserialize( $field->get_value( $view, $source, $entry, $r ) );
                         break;
                     case 'fileupload':
                     case 'business_hours':
-                        $return[$field_id] = json_decode($field->get_value($view, $source, $entry, $r));
+                        $return[ $field_id ] = json_decode( $field->get_value( $view, $source, $entry, $r ) );
                         break;
                     default:
-                        $return[$field_id] = $field->get_value($view, $source, $entry, $r);
+                        $return[ $field_id ] = $field->get_value( $view, $source, $entry, $r );
                 }
             }
         }
@@ -219,41 +219,41 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_items($request)
+    public function get_sub_items( $request )
     {
         $url = $request->get_url_params();
-        $view_id = intval($url['id']);
-        $format = \GV\Utils::get($url, 'format', 'json');
+        $view_id = intval( $url[ 'id' ] );
+        $format = \GV\Utils::get( $url, 'format', 'json' );
 
-        if ($post_id = $request->get_param('post_id')) {
+        if ( $post_id = $request->get_param( 'post_id' ) ) {
             global $post;
 
-            $post = get_post($post_id);
+            $post = get_post( $post_id );
 
-            if (!$post || is_wp_error($post)) {
-                return new \WP_Error('gravityview-post-not-found', sprintf('A post with ID #%d was not found.', $post_id));
+            if ( ! $post || is_wp_error( $post ) ) {
+                return new \WP_Error( 'gravityview-post-not-found', sprintf( 'A post with ID #%d was not found.', $post_id ) );
             }
 
-            $collection = \GV\View_Collection::from_post($post);
+            $collection = \GV\View_Collection::from_post( $post );
 
-            if (!$collection->contains($view_id)) {
-                return new \WP_Error('gravityview-post-not-contains', sprintf('The post with ID #%d does not contain a View with ID #%d', $post_id, $view_id));
+            if ( ! $collection->contains( $view_id ) ) {
+                return new \WP_Error( 'gravityview-post-not-contains', sprintf( 'The post with ID #%d does not contain a View with ID #%d', $post_id, $view_id ) );
             }
         }
 
-        $view = \GV\View::by_id($view_id);
+        $view = \GV\View::by_id( $view_id );
 
-        if ('html' === $format) {
+        if ( 'html' === $format ) {
             $renderer = new \GV\View_Renderer();
             $count = $total = 0;
 
             /** @var \GV\Template_Context $context */
-            add_action('gravityview/template/view/render', function ($context) use (&$count, &$total) {
+            add_action( 'gravityview/template/view/render', function( $context ) use ( &$count, &$total ) {
                 $count = $context->entries->count();
                 $total = $context->entries->total();
             });
 
-            $output = $renderer->render($view, new Request($request));
+            $output = $renderer->render( $view, new Request( $request ) );
 
             /**
              * @filter `gravityview/rest/entries/html/insert_meta` Whether to include `http-equiv` meta tags in the HTML output describing the data
@@ -266,80 +266,80 @@ 
              * @param \WP_REST_Request $request     Request object.
              * @param int              $total       The number of total entries for the request
              */
-            $insert_meta = apply_filters('gravityview/rest/entries/html/insert_meta', true, $count, $view, $request, $total);
+            $insert_meta = apply_filters( 'gravityview/rest/entries/html/insert_meta', true, $count, $view, $request, $total );
 
-            if ($insert_meta) {
-                $output = '<meta http-equiv="X-Item-Count" content="'.$count.'" />'.$output;
-                $output = '<meta http-equiv="X-Item-Total" content="'.$total.'" />'.$output;
+            if ( $insert_meta ) {
+                $output = '<meta http-equiv="X-Item-Count" content="' . $count . '" />' . $output;
+                $output = '<meta http-equiv="X-Item-Total" content="' . $total . '" />' . $output;
             }
 
-            $response = new \WP_REST_Response($output, 200);
-            $response->header('X-Item-Count', $count);
-            $response->header('X-Item-Total', $total);
+            $response = new \WP_REST_Response( $output, 200 );
+            $response->header( 'X-Item-Count', $count );
+            $response->header( 'X-Item-Total', $total );
 
             return $response;
         }
 
-        $entries = $view->get_entries(new Request($request));
+        $entries = $view->get_entries( new Request( $request ) );
 
-        if (!$entries->all()) {
-            return new \WP_Error('gravityview-no-entries', __('No Entries found.', 'gravityview'));
+        if ( ! $entries->all() ) {
+            return new \WP_Error( 'gravityview-no-entries', __( 'No Entries found.', 'gravityview' ) );
         }
 
-        if (in_array($format, ['csv', 'tsv'], true)) {
+        if ( in_array( $format, [ 'csv', 'tsv' ], true ) ) {
             ob_start();
 
-            $csv_or_tsv = fopen('php://output', 'w');
+            $csv_or_tsv = fopen( 'php://output', 'w' );
 
             /** Da' BOM :) */
-            if (apply_filters('gform_include_bom_export_entries', true, $view->form ? $view->form->form : null)) {
-                fputs($csv_or_tsv, "\xef\xbb\xbf");
+            if ( apply_filters( 'gform_include_bom_export_entries', true, $view->form ? $view->form->form : null ) ) {
+                fputs( $csv_or_tsv, "\xef\xbb\xbf" );
             }
 
             $headers_done = false;
 
             // If not "tsv" then use comma
-            $delimiter = ('tsv' === $format) ? "\t" : ',';
+            $delimiter = ( 'tsv' === $format ) ? "\t" : ',';
 
-            foreach ($entries->all() as $entry) {
-                $entry = $this->prepare_entry_for_response($view, $entry, $request, 'directory', '\GV\Field_CSV_Template');
+            foreach ( $entries->all() as $entry ) {
+                $entry = $this->prepare_entry_for_response( $view, $entry, $request, 'directory', '\GV\Field_CSV_Template' );
 
-                if (!$headers_done) {
-                    $headers_done = fputcsv($csv_or_tsv, array_map(['\GV\Utils', 'strip_excel_formulas'], array_keys($entry)), $delimiter);
+                if ( ! $headers_done ) {
+                    $headers_done = fputcsv( $csv_or_tsv, array_map( [ '\GV\Utils', 'strip_excel_formulas' ], array_keys( $entry ) ), $delimiter );
                 }
 
-                fputcsv($csv_or_tsv, array_map(['\GV\Utils', 'strip_excel_formulas'], $entry), $delimiter);
+                fputcsv( $csv_or_tsv, array_map( [ '\GV\Utils', 'strip_excel_formulas' ], $entry ), $delimiter );
             }
 
-            $response = new \WP_REST_Response('', 200);
-            $response->header('X-Item-Count', $entries->count());
-            $response->header('X-Item-Total', $entries->total());
-            $response->header('Content-Type', 'text/'.$format);
+            $response = new \WP_REST_Response( '', 200 );
+            $response->header( 'X-Item-Count', $entries->count() );
+            $response->header( 'X-Item-Total', $entries->total() );
+            $response->header( 'Content-Type', 'text/' . $format );
 
-            fflush($csv_or_tsv);
+            fflush( $csv_or_tsv );
 
-            $data = rtrim(ob_get_clean());
+            $data = rtrim( ob_get_clean() );
 
-            add_filter('rest_pre_serve_request', function () use ($data) {
+            add_filter( 'rest_pre_serve_request', function() use ( $data ) {
                 echo $data;
 
                 return true;
             });
 
-            if (defined('DOING_GRAVITYVIEW_TESTS') && DOING_GRAVITYVIEW_TESTS) {
+            if ( defined( 'DOING_GRAVITYVIEW_TESTS' ) && DOING_GRAVITYVIEW_TESTS ) {
                 echo $data; // rest_pre_serve_request is not called in tests
             }
 
             return $response;
         }
 
-        $data = ['entries' => $entries->all(), 'total' => $entries->total()];
+        $data = [ 'entries' => $entries->all(), 'total' => $entries->total() ];
 
-        foreach ($data['entries'] as &$entry) {
-            $entry = $this->prepare_entry_for_response($view, $entry, $request, 'directory');
+        foreach ( $data[ 'entries' ] as &$entry ) {
+            $entry = $this->prepare_entry_for_response( $view, $entry, $request, 'directory' );
         }
 
-        return new \WP_REST_Response($data, 200);
+        return new \WP_REST_Response( $data, 200 );
     }
 
     /**
@@ -355,23 +355,23 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_item($request)
+    public function get_sub_item( $request )
     {
         $url = $request->get_url_params();
-        $view_id = intval($url['id']);
-        $entry_id = intval($url['s_id']);
-        $format = \GV\Utils::get($url, 'format', 'json');
+        $view_id = intval( $url[ 'id' ] );
+        $entry_id = intval( $url[ 's_id' ] );
+        $format = \GV\Utils::get( $url, 'format', 'json' );
 
-        $view = \GV\View::by_id($view_id);
-        $entry = \GV\GF_Entry::by_id($entry_id);
+        $view = \GV\View::by_id( $view_id );
+        $entry = \GV\GF_Entry::by_id( $entry_id );
 
-        if ($format === 'html') {
+        if ( $format === 'html' ) {
             $renderer = new \GV\Entry_Renderer();
 
-            return $renderer->render($entry, $view, new Request($request));
+            return $renderer->render( $entry, $view, new Request( $request ) );
         }
 
-        return $this->prepare_entry_for_response($view, $entry, $request, 'single');
+        return $this->prepare_entry_for_response( $view, $entry, $request, 'single' );
     }
 
     /**
@@ -384,46 +384,46 @@ 
      *
      * @return mixed
      */
-    public function prepare_view_for_response($view_post, \WP_REST_Request $request)
+    public function prepare_view_for_response( $view_post, \WP_REST_Request $request )
     {
-        if (is_wp_error($this->get_item_permissions_check($request, $view_post->ID))) {
+        if ( is_wp_error( $this->get_item_permissions_check( $request, $view_post->ID ) ) ) {
             // Redacted out view.
-            return ['ID' => $view_post->ID, 'post_content' => __('You are not allowed to access this content.', 'gravityview')];
+            return [ 'ID' => $view_post->ID, 'post_content' => __( 'You are not allowed to access this content.', 'gravityview' ) ];
         }
 
-        $view = \GV\View::from_post($view_post);
+        $view = \GV\View::from_post( $view_post );
 
         $item = $view->as_data();
 
         // Add all the WP_Post data
         $view_post = $view_post->to_array();
 
-        unset($view_post['to_ping'], $view_post['ping_status'], $view_post['pinged'], $view_post['post_type'], $view_post['filter'], $view_post['post_category'], $view_post['tags_input'], $view_post['post_content'], $view_post['post_content_filtered']);
+        unset( $view_post[ 'to_ping' ], $view_post[ 'ping_status' ], $view_post[ 'pinged' ], $view_post[ 'post_type' ], $view_post[ 'filter' ], $view_post[ 'post_category' ], $view_post[ 'tags_input' ], $view_post[ 'post_content' ], $view_post[ 'post_content_filtered' ] );
 
-        $return = wp_parse_args($item, $view_post);
+        $return = wp_parse_args( $item, $view_post );
 
-        $return['title'] = $return['post_title'];
+        $return[ 'title' ] = $return[ 'post_title' ];
 
-        $return['settings'] = isset($return['atts']) ? $return['atts'] : [];
-        unset($return['atts'], $return['view_id']);
+        $return[ 'settings' ] = isset( $return[ 'atts' ] ) ? $return[ 'atts' ] : [ ];
+        unset( $return[ 'atts' ], $return[ 'view_id' ] );
 
-        $return['search_criteria'] = [
-            'page_size'      => rgars($return, 'settings/page_size'),
-            'sort_field'     => rgars($return, 'settings/sort_field'),
-            'sort_direction' => rgars($return, 'settings/sort_direction'),
-            'offset'         => rgars($return, 'settings/offset'),
+        $return[ 'search_criteria' ] = [
+            'page_size'      => rgars( $return, 'settings/page_size' ),
+            'sort_field'     => rgars( $return, 'settings/sort_field' ),
+            'sort_direction' => rgars( $return, 'settings/sort_direction' ),
+            'offset'         => rgars( $return, 'settings/offset' ),
         ];
 
-        unset($return['settings']['page_size'], $return['settings']['sort_field'], $return['settings']['sort_direction']);
+        unset( $return[ 'settings' ][ 'page_size' ], $return[ 'settings' ][ 'sort_field' ], $return[ 'settings' ][ 'sort_direction' ] );
 
         // Redact for non-logged ins
-        if (!\GVCommon::has_cap('edit_others_gravityviews')) {
-            unset($return['settings']);
-            unset($return['search_criteria']);
+        if ( ! \GVCommon::has_cap( 'edit_others_gravityviews' ) ) {
+            unset( $return[ 'settings' ] );
+            unset( $return[ 'search_criteria' ] );
         }
 
-        if (!\GFCommon::current_user_can_any('gravityforms_edit_forms')) {
-            unset($return['form']);
+        if ( ! \GFCommon::current_user_can_any( 'gravityforms_edit_forms' ) ) {
+            unset( $return[ 'form' ] );
         }
 
         return $return;
@@ -434,35 +434,35 @@ 
      *
      * @return bool|\WP_Error
      */
-    public function get_item_permissions_check($request)
+    public function get_item_permissions_check( $request )
     {
-        if (func_num_args() === 2) {
-            $view_id = func_get_arg(1); // $view_id override
+        if ( func_num_args() === 2 ) {
+            $view_id = func_get_arg( 1 ); // $view_id override
         } else {
             $url = $request->get_url_params();
-            $view_id = intval($url['id']);
+            $view_id = intval( $url[ 'id' ] );
         }
 
-        if (!$view = \GV\View::by_id($view_id)) {
-            return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
+        if ( ! $view = \GV\View::by_id( $view_id ) ) {
+            return new \WP_Error( 'rest_forbidden', __( 'You are not allowed to access this content.', 'gravityview' ) );
         }
 
-        while ($error = $view->can_render(['rest'], $request)) {
-            if (!is_wp_error($error)) {
+        while ( $error = $view->can_render( [ 'rest' ], $request ) ) {
+            if ( ! is_wp_error( $error ) ) {
                 break;
             }
 
-            switch (str_replace('gravityview/', '', $error->get_error_code())) {
+            switch ( str_replace( 'gravityview/', '', $error->get_error_code() ) ) {
                 case 'rest_disabled':
                 case 'post_password_required':
                 case 'not_public':
                 case 'embed_only':
                 case 'no_direct_access':
-                    return new \WP_Error('rest_forbidden_access_denied', __('You are not allowed to access this content.', 'gravityview'));
+                    return new \WP_Error( 'rest_forbidden_access_denied', __( 'You are not allowed to access this content.', 'gravityview' ) );
                 case 'no_form_attached':
-                    return new \WP_Error('rest_forbidden_no_form_attached', __('This View is not configured properly.', 'gravityview'));
+                    return new \WP_Error( 'rest_forbidden_no_form_attached', __( 'This View is not configured properly.', 'gravityview' ) );
                 default:
-                    return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
+                    return new \WP_Error( 'rest_forbidden', __( 'You are not allowed to access this content.', 'gravityview' ) );
             }
         }
 
@@ -472,62 +472,62 @@ 
          * @param bool Enable or not.
          * @param \GV\View $view The view.
          */
-        if (!apply_filters('gravityview/view/output/rest', true, $view)) {
-            return new \WP_Error('rest_forbidden', __('You are not allowed to access this content.', 'gravityview'));
+        if ( ! apply_filters( 'gravityview/view/output/rest', true, $view ) ) {
+            return new \WP_Error( 'rest_forbidden', __( 'You are not allowed to access this content.', 'gravityview' ) );
         }
 
         return true;
     }
 
-    public function get_sub_item_permissions_check($request)
+    public function get_sub_item_permissions_check( $request )
     {
         // Accessing a single entry needs the View access permissions.
-        if (is_wp_error($error = $this->get_items_permissions_check($request))) {
+        if ( is_wp_error( $error = $this->get_items_permissions_check( $request ) ) ) {
             return $error;
         }
 
         $url = $request->get_url_params();
-        $view_id = intval($url['id']);
-        $entry_id = intval($url['s_id']);
+        $view_id = intval( $url[ 'id' ] );
+        $entry_id = intval( $url[ 's_id' ] );
 
-        $view = \GV\View::by_id($view_id);
+        $view = \GV\View::by_id( $view_id );
 
-        if (!$entry = \GV\GF_Entry::by_id($entry_id)) {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+        if ( ! $entry = \GV\GF_Entry::by_id( $entry_id ) ) {
+            return new \WP_Error( 'rest_forbidden', 'You are not allowed to view this content.', 'gravityview' );
         }
 
-        if ($entry['form_id'] != $view->form->ID) {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+        if ( $entry[ 'form_id' ] != $view->form->ID ) {
+            return new \WP_Error( 'rest_forbidden', 'You are not allowed to view this content.', 'gravityview' );
         }
 
-        if ($entry['status'] != 'active') {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+        if ( $entry[ 'status' ] != 'active' ) {
+            return new \WP_Error( 'rest_forbidden', 'You are not allowed to view this content.', 'gravityview' );
         }
 
-        if (apply_filters('gravityview_custom_entry_slug', false) && $entry->slug != get_query_var(\GV\Entry::get_endpoint_name())) {
-            return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+        if ( apply_filters( 'gravityview_custom_entry_slug', false ) && $entry->slug != get_query_var( \GV\Entry::get_endpoint_name() ) ) {
+            return new \WP_Error( 'rest_forbidden', 'You are not allowed to view this content.', 'gravityview' );
         }
 
-        $is_admin_and_can_view = $view->settings->get('admin_show_all_statuses') && \GVCommon::has_cap('gravityview_moderate_entries', $view->ID);
+        $is_admin_and_can_view = $view->settings->get( 'admin_show_all_statuses' ) && \GVCommon::has_cap( 'gravityview_moderate_entries', $view->ID );
 
-        if ($view->settings->get('show_only_approved') && !$is_admin_and_can_view) {
-            if (!\GravityView_Entry_Approval_Status::is_approved(gform_get_meta($entry->ID, \GravityView_Entry_Approval::meta_key))) {
-                return new \WP_Error('rest_forbidden', 'You are not allowed to view this content.', 'gravityview');
+        if ( $view->settings->get( 'show_only_approved' ) && ! $is_admin_and_can_view ) {
+            if ( ! \GravityView_Entry_Approval_Status::is_approved( gform_get_meta( $entry->ID, \GravityView_Entry_Approval::meta_key ) ) ) {
+                return new \WP_Error( 'rest_forbidden', 'You are not allowed to view this content.', 'gravityview' );
             }
         }
 
         return true;
     }
 
-    public function get_items_permissions_check($request)
+    public function get_items_permissions_check( $request )
     {
         // Getting a list of all Views is always possible.
         return true;
     }
 
-    public function get_sub_items_permissions_check($request)
+    public function get_sub_items_permissions_check( $request )
     {
         // Accessing all entries of a View needs the same permissions as accessing the View.
-        return $this->get_item_permissions_check($request);
+        return $this->get_item_permissions_check( $request );
     }
 }

Braces +11 added lines, -22 removed lines

@@ -17,8 +17,7 @@ 
     exit();
 }
 
-class Views_Route extends Route
-{
+class Views_Route extends Route {
     /**
      * Route Name.
      *
@@ -46,8 +45,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_items($request)
-    {
+    public function get_items($request) {
         $page = $request->get_param('page');
         $limit = $request->get_param('limit');
 
@@ -82,8 +80,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_item($request)
-    {
+    public function get_item($request) {
         $url = $request->get_url_params();
 
         $view_id = intval($url['id']);
@@ -115,8 +112,7 @@ 
      *
      * @return mixed The data that is sent.
      */
-    public function prepare_entry_for_response($view, $entry, \WP_REST_Request $request, $context, $class = null)
-    {
+    public function prepare_entry_for_response($view, $entry, \WP_REST_Request $request, $context, $class = null) {
 
         // Only output the fields that should be displayed.
         $allowed = [];
@@ -219,8 +215,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_items($request)
-    {
+    public function get_sub_items($request) {
         $url = $request->get_url_params();
         $view_id = intval($url['id']);
         $format = \GV\Utils::get($url, 'format', 'json');
@@ -355,8 +350,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_item($request)
-    {
+    public function get_sub_item($request) {
         $url = $request->get_url_params();
         $view_id = intval($url['id']);
         $entry_id = intval($url['s_id']);
@@ -384,8 +378,7 @@ 
      *
      * @return mixed
      */
-    public function prepare_view_for_response($view_post, \WP_REST_Request $request)
-    {
+    public function prepare_view_for_response($view_post, \WP_REST_Request $request) {
         if (is_wp_error($this->get_item_permissions_check($request, $view_post->ID))) {
             // Redacted out view.
             return ['ID' => $view_post->ID, 'post_content' => __('You are not allowed to access this content.', 'gravityview')];
@@ -434,8 +427,7 @@ 
      *
      * @return bool|\WP_Error
      */
-    public function get_item_permissions_check($request)
-    {
+    public function get_item_permissions_check($request) {
         if (func_num_args() === 2) {
             $view_id = func_get_arg(1); // $view_id override
         } else {
@@ -479,8 +471,7 @@ 
         return true;
     }
 
-    public function get_sub_item_permissions_check($request)
-    {
+    public function get_sub_item_permissions_check($request) {
         // Accessing a single entry needs the View access permissions.
         if (is_wp_error($error = $this->get_items_permissions_check($request))) {
             return $error;
@@ -519,14 +510,12 @@ 
         return true;
     }
 
-    public function get_items_permissions_check($request)
-    {
+    public function get_items_permissions_check($request) {
         // Getting a list of all Views is always possible.
         return true;
     }
 
-    public function get_sub_items_permissions_check($request)
-    {
+    public function get_sub_items_permissions_check($request) {
         // Accessing all entries of a View needs the same permissions as accessing the View.
         return $this->get_item_permissions_check($request);
     }

future/includes/rest/class-gv-rest-route.php

Indentation +435 added lines, -435 removed lines

@@ -14,443 +14,443 @@
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 abstract class Route extends \WP_REST_Controller
 {
-    /**
-     * Route Name.
-     *
-     * @since 2.0
-     *
-     * @var string
-     */
-    protected $route_name;
-
-    /**
-     * Sub type, forms {$namespace}/route_name/{id}/sub_type type endpoints.
-     *
-     * @since 2.0
-     *
-     * @var string
-     */
-    protected $sub_type;
-
-    /**
-     * Register the routes for the objects of the controller.
-     */
-    public function register_routes()
-    {
-        $namespace = \GV\REST\Core::get_namespace();
-        $base = $this->get_route_name();
-
-        register_rest_route($namespace, '/'.$base, [
-            [
-                'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_items'],
-                'permission_callback' => [$this, 'get_items_permissions_check'],
-                'args'                => [
-                    'page' => [
-                        'default'           => 1,
-                        'sanitize_callback' => 'absint',
-                    ],
-                    'limit' => [
-                        'default'           => 10,
-                        'sanitize_callback' => 'absint',
-                    ],
-                    'post_id' => [
-                        'default'           => null,
-                        'sanitize_callback' => 'absint',
-                    ],
-                ],
-            ],
-            [
-                'methods'             => \WP_REST_Server::CREATABLE,
-                'callback'            => [$this, 'create_item'],
-                'permission_callback' => [$this, 'create_item_permissions_check'],
-                'args'                => $this->create_item_args(),
-
-            ],
-        ]);
-        register_rest_route($namespace, '/'.$base.'/(?P<id>[\d]+)', [
-            [
-                'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_item'],
-                'permission_callback' => [$this, 'get_item_permissions_check'],
-                'args'                => [
-                    'context'          => [
-                        'default'      => 'view',
-                    ],
-                ],
-            ],
-            [
-                'methods'             => \WP_REST_Server::EDITABLE,
-                'callback'            => [$this, 'update_item'],
-                'permission_callback' => [$this, 'update_item_permissions_check'],
-                'args'                => $this->update_item_args(),
-            ],
-            [
-                'methods'             => \WP_REST_Server::DELETABLE,
-                'callback'            => [$this, 'delete_item'],
-                'permission_callback' => [$this, 'delete_item_permissions_check'],
-                'args'                => [
-                    'force'    => [
-                        'default'      => false,
-                    ],
-                ],
-            ],
-        ]);
-
-        $sub_type = $this->get_sub_type();
-
-        $format = '(?:\.(?P<format>html|json|csv|tsv))?';
-
-        register_rest_route($namespace, '/'.$base.'/(?P<id>[\d]+)'.'/'.$sub_type.$format, [
-            [
-                'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_sub_items'],
-                'permission_callback' => [$this, 'get_sub_items_permissions_check'],
-                'args'                => [
-                    'page' => [
-                        'default'           => 1,
-                        'sanitize_callback' => 'absint',
-                    ],
-                    'limit' => [
-                        'default'           => 10,
-                        'sanitize_callback' => 'absint',
-                    ],
-                    'post_id' => [
-                        'default'           => null,
-                        'sanitize_callback' => 'absint',
-                    ],
-                ],
-            ],
-            [
-                'methods'             => \WP_REST_Server::CREATABLE,
-                'callback'            => [$this, 'create_sub_item'],
-                'permission_callback' => [$this, 'create_sub_item_permissions_check'],
-                'args'                => $this->create_sub_item_args(),
-            ],
-        ]);
-
-        $format = '(?:\.(?P<format>html|json))?';
-
-        register_rest_route($namespace, sprintf('/%s/(?P<id>[\d]+)/%s/(?P<s_id>[\w-]+)%s', $base, $sub_type, $format), [
-            [
-                'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_sub_item'],
-                'permission_callback' => [$this, 'get_sub_item_permissions_check'],
-                'args'                => [
-                    'context'          => [
-                        'default'      => 'view',
-                    ],
-                ],
-            ],
-            [
-                'methods'             => \WP_REST_Server::EDITABLE,
-                'callback'            => [$this, 'update_sub_item'],
-                'permission_callback' => [$this, 'update_sub_item_permissions_check'],
-                'args'                => $this->update_sub_item_args(),
-            ],
-            [
-                'methods'             => \WP_REST_Server::DELETABLE,
-                'callback'            => [$this, 'delete_sub_item'],
-                'permission_callback' => [$this, 'delete_sub_item_permissions_check'],
-                'args'                => [
-                    'force'    => [
-                        'default'      => false,
-                    ],
-                ],
-            ],
-        ]);
-    }
-
-    /**
-     * Get route name.
-     *
-     * MUST SET route_name property in subclass!
-     *
-     * @since 2.0
-     *
-     * @return string
-     */
-    protected function get_route_name()
-    {
-        if (is_string($this->route_name)) {
-            return $this->route_name;
-        } else {
-            _doing_it_wrong(__METHOD__, __('Must set route name in subclass.', 'gravityview'), '2.0');
-
-            return '';
-        }
-    }
-
-    /**
-     * Get sub_type.
-     *
-     * MUST SET sub_type property in subclass!
-     *
-     * @since 2.0
-     *
-     * @return string
-     */
-    protected function get_sub_type()
-    {
-        if (is_string($this->sub_type)) {
-            return $this->sub_type;
-        } else {
-            _doing_it_wrong(__METHOD__, __('Must set route sub type in subclass.', 'gravityview'), '2.0');
-
-            return '';
-        }
-    }
-
-    /**
-     * Get a collection of items.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_items($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Get one item from the collection.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Create one item from the collection.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function create_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Update one item from the collection.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function update_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Delete one item from the collection.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function delete_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Get a collection of items.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_sub_items($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Get one item from the collection.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_Error|\WP_REST_Response
-     */
-    public function get_sub_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Create one item from the collection.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function create_sub_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Update one item from the collection for sub items.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function update_sub_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Delete one item from the collection for sub items.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function delete_sub_item($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Check if a given request has access to get items.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function get_items_permissions_check($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Check if a given request has access to get a specific item.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function get_item_permissions_check($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Check if a given request has access to create items.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function create_item_permissions_check($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Check if a given request has access to update a specific item.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function update_item_permissions_check($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Check if a given request has access to delete a specific item.
-     *
-     * @param \WP_REST_Request $request Full data about the request.
-     *
-     * @return \WP_REST_Response
-     */
-    public function delete_item_permissions_check($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Prepare the item for create or update operation.
-     *
-     * @todo ZACK - Use this as generic prepare to save or remove from usage.
-     *
-     * @param \WP_REST_Request $request Request object
-     *
-     * @return \WP_REST_Response
-     */
-    protected function prepare_item_for_database($request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Prepare the item for the REST response.
-     *
-     *  @todo ZACK - Use this as generic prepare for response or remove from usage
-     *
-     * @since 2.0
-     *
-     * @param mixed            $item    WordPress representation of the item.
-     * @param \WP_REST_Request $request Request object.
-     *
-     * @return \WP_REST_Response
-     */
-    public function prepare_item_for_response($item, $request)
-    {
-        return $this->not_implemented();
-    }
-
-    /**
-     * Generic response for routes not yet implemented.
-     *
-     * @since 2.0
-     *
-     * @return \WP_REST_Response
-     */
-    protected function not_implemented()
-    {
-        $error = new \WP_Error('not-implemented-yet', __('Endpoint Not Yet Implemented.', 'gravityview'));
-
-        return new \WP_REST_Response($error, 501);
-    }
-
-    /**
-     * Fallback if subclass doesn't define routes.
-     *
-     * Returns empty array for args instead of making an error.
-     *
-     * @since 2.0
-     *
-     * @param $method
-     *
-     * @return array
-     */
-    public function __call($method, $args)
-    {
-        if (in_array($method, [
-            'create_item_args',
-            'update_item_args',
-            'create_sub_item_args',
-            'update_sub_item_args',
-        ])) {
-            return [];
-        }
-    }
+	/**
+	 * Route Name.
+	 *
+	 * @since 2.0
+	 *
+	 * @var string
+	 */
+	protected $route_name;
+
+	/**
+	 * Sub type, forms {$namespace}/route_name/{id}/sub_type type endpoints.
+	 *
+	 * @since 2.0
+	 *
+	 * @var string
+	 */
+	protected $sub_type;
+
+	/**
+	 * Register the routes for the objects of the controller.
+	 */
+	public function register_routes()
+	{
+		$namespace = \GV\REST\Core::get_namespace();
+		$base = $this->get_route_name();
+
+		register_rest_route($namespace, '/'.$base, [
+			[
+				'methods'             => \WP_REST_Server::READABLE,
+				'callback'            => [$this, 'get_items'],
+				'permission_callback' => [$this, 'get_items_permissions_check'],
+				'args'                => [
+					'page' => [
+						'default'           => 1,
+						'sanitize_callback' => 'absint',
+					],
+					'limit' => [
+						'default'           => 10,
+						'sanitize_callback' => 'absint',
+					],
+					'post_id' => [
+						'default'           => null,
+						'sanitize_callback' => 'absint',
+					],
+				],
+			],
+			[
+				'methods'             => \WP_REST_Server::CREATABLE,
+				'callback'            => [$this, 'create_item'],
+				'permission_callback' => [$this, 'create_item_permissions_check'],
+				'args'                => $this->create_item_args(),
+
+			],
+		]);
+		register_rest_route($namespace, '/'.$base.'/(?P<id>[\d]+)', [
+			[
+				'methods'             => \WP_REST_Server::READABLE,
+				'callback'            => [$this, 'get_item'],
+				'permission_callback' => [$this, 'get_item_permissions_check'],
+				'args'                => [
+					'context'          => [
+						'default'      => 'view',
+					],
+				],
+			],
+			[
+				'methods'             => \WP_REST_Server::EDITABLE,
+				'callback'            => [$this, 'update_item'],
+				'permission_callback' => [$this, 'update_item_permissions_check'],
+				'args'                => $this->update_item_args(),
+			],
+			[
+				'methods'             => \WP_REST_Server::DELETABLE,
+				'callback'            => [$this, 'delete_item'],
+				'permission_callback' => [$this, 'delete_item_permissions_check'],
+				'args'                => [
+					'force'    => [
+						'default'      => false,
+					],
+				],
+			],
+		]);
+
+		$sub_type = $this->get_sub_type();
+
+		$format = '(?:\.(?P<format>html|json|csv|tsv))?';
+
+		register_rest_route($namespace, '/'.$base.'/(?P<id>[\d]+)'.'/'.$sub_type.$format, [
+			[
+				'methods'             => \WP_REST_Server::READABLE,
+				'callback'            => [$this, 'get_sub_items'],
+				'permission_callback' => [$this, 'get_sub_items_permissions_check'],
+				'args'                => [
+					'page' => [
+						'default'           => 1,
+						'sanitize_callback' => 'absint',
+					],
+					'limit' => [
+						'default'           => 10,
+						'sanitize_callback' => 'absint',
+					],
+					'post_id' => [
+						'default'           => null,
+						'sanitize_callback' => 'absint',
+					],
+				],
+			],
+			[
+				'methods'             => \WP_REST_Server::CREATABLE,
+				'callback'            => [$this, 'create_sub_item'],
+				'permission_callback' => [$this, 'create_sub_item_permissions_check'],
+				'args'                => $this->create_sub_item_args(),
+			],
+		]);
+
+		$format = '(?:\.(?P<format>html|json))?';
+
+		register_rest_route($namespace, sprintf('/%s/(?P<id>[\d]+)/%s/(?P<s_id>[\w-]+)%s', $base, $sub_type, $format), [
+			[
+				'methods'             => \WP_REST_Server::READABLE,
+				'callback'            => [$this, 'get_sub_item'],
+				'permission_callback' => [$this, 'get_sub_item_permissions_check'],
+				'args'                => [
+					'context'          => [
+						'default'      => 'view',
+					],
+				],
+			],
+			[
+				'methods'             => \WP_REST_Server::EDITABLE,
+				'callback'            => [$this, 'update_sub_item'],
+				'permission_callback' => [$this, 'update_sub_item_permissions_check'],
+				'args'                => $this->update_sub_item_args(),
+			],
+			[
+				'methods'             => \WP_REST_Server::DELETABLE,
+				'callback'            => [$this, 'delete_sub_item'],
+				'permission_callback' => [$this, 'delete_sub_item_permissions_check'],
+				'args'                => [
+					'force'    => [
+						'default'      => false,
+					],
+				],
+			],
+		]);
+	}
+
+	/**
+	 * Get route name.
+	 *
+	 * MUST SET route_name property in subclass!
+	 *
+	 * @since 2.0
+	 *
+	 * @return string
+	 */
+	protected function get_route_name()
+	{
+		if (is_string($this->route_name)) {
+			return $this->route_name;
+		} else {
+			_doing_it_wrong(__METHOD__, __('Must set route name in subclass.', 'gravityview'), '2.0');
+
+			return '';
+		}
+	}
+
+	/**
+	 * Get sub_type.
+	 *
+	 * MUST SET sub_type property in subclass!
+	 *
+	 * @since 2.0
+	 *
+	 * @return string
+	 */
+	protected function get_sub_type()
+	{
+		if (is_string($this->sub_type)) {
+			return $this->sub_type;
+		} else {
+			_doing_it_wrong(__METHOD__, __('Must set route sub type in subclass.', 'gravityview'), '2.0');
+
+			return '';
+		}
+	}
+
+	/**
+	 * Get a collection of items.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_items($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Get one item from the collection.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Create one item from the collection.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function create_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Update one item from the collection.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function update_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Delete one item from the collection.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function delete_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Get a collection of items.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_sub_items($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Get one item from the collection.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_Error|\WP_REST_Response
+	 */
+	public function get_sub_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Create one item from the collection.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function create_sub_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Update one item from the collection for sub items.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function update_sub_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Delete one item from the collection for sub items.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function delete_sub_item($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Check if a given request has access to get items.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function get_items_permissions_check($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Check if a given request has access to get a specific item.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function get_item_permissions_check($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Check if a given request has access to create items.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function create_item_permissions_check($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Check if a given request has access to update a specific item.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function update_item_permissions_check($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Check if a given request has access to delete a specific item.
+	 *
+	 * @param \WP_REST_Request $request Full data about the request.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function delete_item_permissions_check($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Prepare the item for create or update operation.
+	 *
+	 * @todo ZACK - Use this as generic prepare to save or remove from usage.
+	 *
+	 * @param \WP_REST_Request $request Request object
+	 *
+	 * @return \WP_REST_Response
+	 */
+	protected function prepare_item_for_database($request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Prepare the item for the REST response.
+	 *
+	 *  @todo ZACK - Use this as generic prepare for response or remove from usage
+	 *
+	 * @since 2.0
+	 *
+	 * @param mixed            $item    WordPress representation of the item.
+	 * @param \WP_REST_Request $request Request object.
+	 *
+	 * @return \WP_REST_Response
+	 */
+	public function prepare_item_for_response($item, $request)
+	{
+		return $this->not_implemented();
+	}
+
+	/**
+	 * Generic response for routes not yet implemented.
+	 *
+	 * @since 2.0
+	 *
+	 * @return \WP_REST_Response
+	 */
+	protected function not_implemented()
+	{
+		$error = new \WP_Error('not-implemented-yet', __('Endpoint Not Yet Implemented.', 'gravityview'));
+
+		return new \WP_REST_Response($error, 501);
+	}
+
+	/**
+	 * Fallback if subclass doesn't define routes.
+	 *
+	 * Returns empty array for args instead of making an error.
+	 *
+	 * @since 2.0
+	 *
+	 * @param $method
+	 *
+	 * @return array
+	 */
+	public function __call($method, $args)
+	{
+		if (in_array($method, [
+			'create_item_args',
+			'update_item_args',
+			'create_sub_item_args',
+			'update_sub_item_args',
+		])) {
+			return [];
+		}
+	}
 }

Spacing +56 added lines, -56 removed lines

@@ -13,7 +13,7 @@ 
 namespace GV\REST;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -45,11 +45,11 @@ 
         $namespace = \GV\REST\Core::get_namespace();
         $base = $this->get_route_name();
 
-        register_rest_route($namespace, '/'.$base, [
+        register_rest_route( $namespace, '/' . $base, [
             [
                 'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_items'],
-                'permission_callback' => [$this, 'get_items_permissions_check'],
+                'callback'            => [ $this, 'get_items' ],
+                'permission_callback' => [ $this, 'get_items_permissions_check' ],
                 'args'                => [
                     'page' => [
                         'default'           => 1,
@@ -67,17 +67,17 @@ 
             ],
             [
                 'methods'             => \WP_REST_Server::CREATABLE,
-                'callback'            => [$this, 'create_item'],
-                'permission_callback' => [$this, 'create_item_permissions_check'],
+                'callback'            => [ $this, 'create_item' ],
+                'permission_callback' => [ $this, 'create_item_permissions_check' ],
                 'args'                => $this->create_item_args(),
 
             ],
-        ]);
-        register_rest_route($namespace, '/'.$base.'/(?P<id>[\d]+)', [
+        ] );
+        register_rest_route( $namespace, '/' . $base . '/(?P<id>[\d]+)', [
             [
                 'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_item'],
-                'permission_callback' => [$this, 'get_item_permissions_check'],
+                'callback'            => [ $this, 'get_item' ],
+                'permission_callback' => [ $this, 'get_item_permissions_check' ],
                 'args'                => [
                     'context'          => [
                         'default'      => 'view',
@@ -86,31 +86,31 @@ 
             ],
             [
                 'methods'             => \WP_REST_Server::EDITABLE,
-                'callback'            => [$this, 'update_item'],
-                'permission_callback' => [$this, 'update_item_permissions_check'],
+                'callback'            => [ $this, 'update_item' ],
+                'permission_callback' => [ $this, 'update_item_permissions_check' ],
                 'args'                => $this->update_item_args(),
             ],
             [
                 'methods'             => \WP_REST_Server::DELETABLE,
-                'callback'            => [$this, 'delete_item'],
-                'permission_callback' => [$this, 'delete_item_permissions_check'],
+                'callback'            => [ $this, 'delete_item' ],
+                'permission_callback' => [ $this, 'delete_item_permissions_check' ],
                 'args'                => [
                     'force'    => [
                         'default'      => false,
                     ],
                 ],
             ],
-        ]);
+        ] );
 
         $sub_type = $this->get_sub_type();
 
         $format = '(?:\.(?P<format>html|json|csv|tsv))?';
 
-        register_rest_route($namespace, '/'.$base.'/(?P<id>[\d]+)'.'/'.$sub_type.$format, [
+        register_rest_route( $namespace, '/' . $base . '/(?P<id>[\d]+)' . '/' . $sub_type . $format, [
             [
                 'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_sub_items'],
-                'permission_callback' => [$this, 'get_sub_items_permissions_check'],
+                'callback'            => [ $this, 'get_sub_items' ],
+                'permission_callback' => [ $this, 'get_sub_items_permissions_check' ],
                 'args'                => [
                     'page' => [
                         'default'           => 1,
@@ -128,19 +128,19 @@ 
             ],
             [
                 'methods'             => \WP_REST_Server::CREATABLE,
-                'callback'            => [$this, 'create_sub_item'],
-                'permission_callback' => [$this, 'create_sub_item_permissions_check'],
+                'callback'            => [ $this, 'create_sub_item' ],
+                'permission_callback' => [ $this, 'create_sub_item_permissions_check' ],
                 'args'                => $this->create_sub_item_args(),
             ],
-        ]);
+        ] );
 
         $format = '(?:\.(?P<format>html|json))?';
 
-        register_rest_route($namespace, sprintf('/%s/(?P<id>[\d]+)/%s/(?P<s_id>[\w-]+)%s', $base, $sub_type, $format), [
+        register_rest_route( $namespace, sprintf( '/%s/(?P<id>[\d]+)/%s/(?P<s_id>[\w-]+)%s', $base, $sub_type, $format ), [
             [
                 'methods'             => \WP_REST_Server::READABLE,
-                'callback'            => [$this, 'get_sub_item'],
-                'permission_callback' => [$this, 'get_sub_item_permissions_check'],
+                'callback'            => [ $this, 'get_sub_item' ],
+                'permission_callback' => [ $this, 'get_sub_item_permissions_check' ],
                 'args'                => [
                     'context'          => [
                         'default'      => 'view',
@@ -149,21 +149,21 @@ 
             ],
             [
                 'methods'             => \WP_REST_Server::EDITABLE,
-                'callback'            => [$this, 'update_sub_item'],
-                'permission_callback' => [$this, 'update_sub_item_permissions_check'],
+                'callback'            => [ $this, 'update_sub_item' ],
+                'permission_callback' => [ $this, 'update_sub_item_permissions_check' ],
                 'args'                => $this->update_sub_item_args(),
             ],
             [
                 'methods'             => \WP_REST_Server::DELETABLE,
-                'callback'            => [$this, 'delete_sub_item'],
-                'permission_callback' => [$this, 'delete_sub_item_permissions_check'],
+                'callback'            => [ $this, 'delete_sub_item' ],
+                'permission_callback' => [ $this, 'delete_sub_item_permissions_check' ],
                 'args'                => [
                     'force'    => [
                         'default'      => false,
                     ],
                 ],
             ],
-        ]);
+        ] );
     }
 
     /**
@@ -177,10 +177,10 @@ 
      */
     protected function get_route_name()
     {
-        if (is_string($this->route_name)) {
+        if ( is_string( $this->route_name ) ) {
             return $this->route_name;
         } else {
-            _doing_it_wrong(__METHOD__, __('Must set route name in subclass.', 'gravityview'), '2.0');
+            _doing_it_wrong( __METHOD__, __( 'Must set route name in subclass.', 'gravityview' ), '2.0' );
 
             return '';
         }
@@ -197,10 +197,10 @@ 
      */
     protected function get_sub_type()
     {
-        if (is_string($this->sub_type)) {
+        if ( is_string( $this->sub_type ) ) {
             return $this->sub_type;
         } else {
-            _doing_it_wrong(__METHOD__, __('Must set route sub type in subclass.', 'gravityview'), '2.0');
+            _doing_it_wrong( __METHOD__, __( 'Must set route sub type in subclass.', 'gravityview' ), '2.0' );
 
             return '';
         }
@@ -213,7 +213,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_items($request)
+    public function get_items( $request )
     {
         return $this->not_implemented();
     }
@@ -225,7 +225,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_item($request)
+    public function get_item( $request )
     {
         return $this->not_implemented();
     }
@@ -237,7 +237,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function create_item($request)
+    public function create_item( $request )
     {
         return $this->not_implemented();
     }
@@ -249,7 +249,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function update_item($request)
+    public function update_item( $request )
     {
         return $this->not_implemented();
     }
@@ -261,7 +261,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function delete_item($request)
+    public function delete_item( $request )
     {
         return $this->not_implemented();
     }
@@ -273,7 +273,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_items($request)
+    public function get_sub_items( $request )
     {
         return $this->not_implemented();
     }
@@ -285,7 +285,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_item($request)
+    public function get_sub_item( $request )
     {
         return $this->not_implemented();
     }
@@ -297,7 +297,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function create_sub_item($request)
+    public function create_sub_item( $request )
     {
         return $this->not_implemented();
     }
@@ -309,7 +309,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function update_sub_item($request)
+    public function update_sub_item( $request )
     {
         return $this->not_implemented();
     }
@@ -321,7 +321,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function delete_sub_item($request)
+    public function delete_sub_item( $request )
     {
         return $this->not_implemented();
     }
@@ -333,7 +333,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function get_items_permissions_check($request)
+    public function get_items_permissions_check( $request )
     {
         return $this->not_implemented();
     }
@@ -345,7 +345,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function get_item_permissions_check($request)
+    public function get_item_permissions_check( $request )
     {
         return $this->not_implemented();
     }
@@ -357,7 +357,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function create_item_permissions_check($request)
+    public function create_item_permissions_check( $request )
     {
         return $this->not_implemented();
     }
@@ -369,7 +369,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function update_item_permissions_check($request)
+    public function update_item_permissions_check( $request )
     {
         return $this->not_implemented();
     }
@@ -381,7 +381,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function delete_item_permissions_check($request)
+    public function delete_item_permissions_check( $request )
     {
         return $this->not_implemented();
     }
@@ -395,7 +395,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    protected function prepare_item_for_database($request)
+    protected function prepare_item_for_database( $request )
     {
         return $this->not_implemented();
     }
@@ -412,7 +412,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function prepare_item_for_response($item, $request)
+    public function prepare_item_for_response( $item, $request )
     {
         return $this->not_implemented();
     }
@@ -426,9 +426,9 @@ 
      */
     protected function not_implemented()
     {
-        $error = new \WP_Error('not-implemented-yet', __('Endpoint Not Yet Implemented.', 'gravityview'));
+        $error = new \WP_Error( 'not-implemented-yet', __( 'Endpoint Not Yet Implemented.', 'gravityview' ) );
 
-        return new \WP_REST_Response($error, 501);
+        return new \WP_REST_Response( $error, 501 );
     }
 
     /**
@@ -442,15 +442,15 @@ 
      *
      * @return array
      */
-    public function __call($method, $args)
+    public function __call( $method, $args )
     {
-        if (in_array($method, [
+        if ( in_array( $method, [
             'create_item_args',
             'update_item_args',
             'create_sub_item_args',
             'update_sub_item_args',
-        ])) {
-            return [];
+        ] ) ) {
+            return [ ];
         }
     }
 }

Braces +22 added lines, -44 removed lines

@@ -40,8 +40,7 @@ 
     /**
      * Register the routes for the objects of the controller.
      */
-    public function register_routes()
-    {
+    public function register_routes() {
         $namespace = \GV\REST\Core::get_namespace();
         $base = $this->get_route_name();
 
@@ -175,8 +174,7 @@ 
      *
      * @return string
      */
-    protected function get_route_name()
-    {
+    protected function get_route_name() {
         if (is_string($this->route_name)) {
             return $this->route_name;
         } else {
@@ -195,8 +193,7 @@ 
      *
      * @return string
      */
-    protected function get_sub_type()
-    {
+    protected function get_sub_type() {
         if (is_string($this->sub_type)) {
             return $this->sub_type;
         } else {
@@ -213,8 +210,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_items($request)
-    {
+    public function get_items($request) {
         return $this->not_implemented();
     }
 
@@ -225,8 +221,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_item($request)
-    {
+    public function get_item($request) {
         return $this->not_implemented();
     }
 
@@ -237,8 +232,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function create_item($request)
-    {
+    public function create_item($request) {
         return $this->not_implemented();
     }
 
@@ -249,8 +243,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function update_item($request)
-    {
+    public function update_item($request) {
         return $this->not_implemented();
     }
 
@@ -261,8 +254,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function delete_item($request)
-    {
+    public function delete_item($request) {
         return $this->not_implemented();
     }
 
@@ -273,8 +265,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_items($request)
-    {
+    public function get_sub_items($request) {
         return $this->not_implemented();
     }
 
@@ -285,8 +276,7 @@ 
      *
      * @return \WP_Error|\WP_REST_Response
      */
-    public function get_sub_item($request)
-    {
+    public function get_sub_item($request) {
         return $this->not_implemented();
     }
 
@@ -297,8 +287,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function create_sub_item($request)
-    {
+    public function create_sub_item($request) {
         return $this->not_implemented();
     }
 
@@ -309,8 +298,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function update_sub_item($request)
-    {
+    public function update_sub_item($request) {
         return $this->not_implemented();
     }
 
@@ -321,8 +309,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function delete_sub_item($request)
-    {
+    public function delete_sub_item($request) {
         return $this->not_implemented();
     }
 
@@ -333,8 +320,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function get_items_permissions_check($request)
-    {
+    public function get_items_permissions_check($request) {
         return $this->not_implemented();
     }
 
@@ -345,8 +331,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function get_item_permissions_check($request)
-    {
+    public function get_item_permissions_check($request) {
         return $this->not_implemented();
     }
 
@@ -357,8 +342,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function create_item_permissions_check($request)
-    {
+    public function create_item_permissions_check($request) {
         return $this->not_implemented();
     }
 
@@ -369,8 +353,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function update_item_permissions_check($request)
-    {
+    public function update_item_permissions_check($request) {
         return $this->not_implemented();
     }
 
@@ -381,8 +364,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function delete_item_permissions_check($request)
-    {
+    public function delete_item_permissions_check($request) {
         return $this->not_implemented();
     }
 
@@ -395,8 +377,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    protected function prepare_item_for_database($request)
-    {
+    protected function prepare_item_for_database($request) {
         return $this->not_implemented();
     }
 
@@ -412,8 +393,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    public function prepare_item_for_response($item, $request)
-    {
+    public function prepare_item_for_response($item, $request) {
         return $this->not_implemented();
     }
 
@@ -424,8 +404,7 @@ 
      *
      * @return \WP_REST_Response
      */
-    protected function not_implemented()
-    {
+    protected function not_implemented() {
         $error = new \WP_Error('not-implemented-yet', __('Endpoint Not Yet Implemented.', 'gravityview'));
 
         return new \WP_REST_Response($error, 501);
@@ -442,8 +421,7 @@ 
      *
      * @return array
      */
-    public function __call($method, $args)
-    {
+    public function __call($method, $args) {
         if (in_array($method, [
             'create_item_args',
             'update_item_args',

future/includes/rest/class-gv-request-rest.php

Indentation +23 added lines, -23 removed lines

@@ -4,7 +4,7 @@ 
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 /**
@@ -12,28 +12,28 @@ 
  */
 class Request extends \GV\Request
 {
-    private $request;
+	private $request;
 
-    /**
-     * @param \WP_REST_Request $request The WordPress REST request object.
-     */
-    public function __construct(\WP_REST_Request $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * @param \WP_REST_Request $request The WordPress REST request object.
+	 */
+	public function __construct(\WP_REST_Request $request)
+	{
+		$this->request = $request;
+	}
 
-    /**
-     * Retrieve paging parameters if any.
-     *
-     * @return array
-     */
-    public function get_paging()
-    {
-        return [
-            'paging' => [
-                'page_size'    => $this->request->get_param('limit'),
-                'current_page' => $this->request->get_param('page'),
-            ],
-        ];
-    }
+	/**
+	 * Retrieve paging parameters if any.
+	 *
+	 * @return array
+	 */
+	public function get_paging()
+	{
+		return [
+			'paging' => [
+				'page_size'    => $this->request->get_param('limit'),
+				'current_page' => $this->request->get_param('page'),
+			],
+		];
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -3,7 +3,7 @@ 
 namespace GV\REST;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -17,7 +17,7 @@ 
     /**
      * @param \WP_REST_Request $request The WordPress REST request object.
      */
-    public function __construct(\WP_REST_Request $request)
+    public function __construct( \WP_REST_Request $request )
     {
         $this->request = $request;
     }
@@ -31,8 +31,8 @@ 
     {
         return [
             'paging' => [
-                'page_size'    => $this->request->get_param('limit'),
-                'current_page' => $this->request->get_param('page'),
+                'page_size'    => $this->request->get_param( 'limit' ),
+                'current_page' => $this->request->get_param( 'page' ),
             ],
         ];
     }

Braces +2 added lines, -4 removed lines

@@ -17,8 +17,7 @@ 
     /**
      * @param \WP_REST_Request $request The WordPress REST request object.
      */
-    public function __construct(\WP_REST_Request $request)
-    {
+    public function __construct(\WP_REST_Request $request) {
         $this->request = $request;
     }
 
@@ -27,8 +26,7 @@ 
      *
      * @return array
      */
-    public function get_paging()
-    {
+    public function get_paging() {
         return [
             'paging' => [
                 'page_size'    => $this->request->get_param('limit'),

future/includes/rest/class-gv-rest-core.php

Indentation +43 added lines, -43 removed lines

@@ -4,51 +4,51 @@
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 class Core
 {
-    public static $routes;
-
-    /**
-     * Initialization.
-     */
-    public static function init()
-    {
-        if (!gravityview()->plugin->supports(\GV\Plugin::FEATURE_REST)) {
-            return;
-        }
-
-        /** Load routes. */
-        require_once gravityview()->plugin->dir('future/includes/rest/class-gv-rest-route.php');
-        require_once gravityview()->plugin->dir('future/includes/rest/class-gv-rest-views-route.php');
-
-        self::$routes['views'] = $views = new Views_Route();
-        $views->register_routes();
-    }
-
-    /**
-     * Get namespace for GravityView REST API endpoints.
-     *
-     * @since 2.0
-     *
-     * @return string
-     */
-    public static function get_namespace()
-    {
-        return 'gravityview/v1';
-    }
-
-    /**
-     * Get root URL for GravityView REST API.
-     *
-     * @since 2.0
-     *
-     * @return string
-     */
-    public static function get_url()
-    {
-        return rest_url(self::get_namespace());
-    }
+	public static $routes;
+
+	/**
+	 * Initialization.
+	 */
+	public static function init()
+	{
+		if (!gravityview()->plugin->supports(\GV\Plugin::FEATURE_REST)) {
+			return;
+		}
+
+		/** Load routes. */
+		require_once gravityview()->plugin->dir('future/includes/rest/class-gv-rest-route.php');
+		require_once gravityview()->plugin->dir('future/includes/rest/class-gv-rest-views-route.php');
+
+		self::$routes['views'] = $views = new Views_Route();
+		$views->register_routes();
+	}
+
+	/**
+	 * Get namespace for GravityView REST API endpoints.
+	 *
+	 * @since 2.0
+	 *
+	 * @return string
+	 */
+	public static function get_namespace()
+	{
+		return 'gravityview/v1';
+	}
+
+	/**
+	 * Get root URL for GravityView REST API.
+	 *
+	 * @since 2.0
+	 *
+	 * @return string
+	 */
+	public static function get_url()
+	{
+		return rest_url(self::get_namespace());
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -3,7 +3,7 @@ 
 namespace GV\REST;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -16,15 +16,15 @@ 
      */
     public static function init()
     {
-        if (!gravityview()->plugin->supports(\GV\Plugin::FEATURE_REST)) {
+        if ( ! gravityview()->plugin->supports( \GV\Plugin::FEATURE_REST ) ) {
             return;
         }
 
         /** Load routes. */
-        require_once gravityview()->plugin->dir('future/includes/rest/class-gv-rest-route.php');
-        require_once gravityview()->plugin->dir('future/includes/rest/class-gv-rest-views-route.php');
+        require_once gravityview()->plugin->dir( 'future/includes/rest/class-gv-rest-route.php' );
+        require_once gravityview()->plugin->dir( 'future/includes/rest/class-gv-rest-views-route.php' );
 
-        self::$routes['views'] = $views = new Views_Route();
+        self::$routes[ 'views' ] = $views = new Views_Route();
         $views->register_routes();
     }
 
@@ -49,6 +49,6 @@ 
      */
     public static function get_url()
     {
-        return rest_url(self::get_namespace());
+        return rest_url( self::get_namespace() );
     }
 }

Braces +4 added lines, -8 removed lines

@@ -7,15 +7,13 @@ 
     exit();
 }
 
-class Core
-{
+class Core {
     public static $routes;
 
     /**
      * Initialization.
      */
-    public static function init()
-    {
+    public static function init() {
         if (!gravityview()->plugin->supports(\GV\Plugin::FEATURE_REST)) {
             return;
         }
@@ -35,8 +33,7 @@ 
      *
      * @return string
      */
-    public static function get_namespace()
-    {
+    public static function get_namespace() {
         return 'gravityview/v1';
     }
 
@@ -47,8 +44,7 @@ 
      *
      * @return string
      */
-    public static function get_url()
-    {
+    public static function get_url() {
         return rest_url(self::get_namespace());
     }
 }

future/includes/class-gv-renderer-view.php

Indentation +143 added lines, -143 removed lines

@@ -4,7 +4,7 @@ 
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 /**
@@ -14,146 +14,146 @@ 
  */
 class View_Renderer extends Renderer
 {
-    /**
-     * Renders a \GV\View instance.
-     *
-     * @param \GV\View    $view    The View instance to render.
-     * @param \GV\Request $request The request context we're currently in. Default: `gravityview()->request`
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return string The rendered View.
-     */
-    public function render(View $view, Request $request = null)
-    {
-        if (is_null($request)) {
-            $request = &gravityview()->request;
-        }
-
-        if (!$request->is_renderable()) {
-            gravityview()->log->error('Renderer unable to render View in {request_class} context', ['request_class' => get_class($request)]);
-
-            return null;
-        }
-
-        /**
-         * @filter `gravityview_template_slug_{$template_id}` Modify the template slug about to be loaded in directory views.
-         *
-         * @since 1.6
-         * @deprecated
-         * @see The `gravityview_get_template_id` filter
-         *
-         * @param string $slug Default: 'table'
-         * @param string $view The current view context: directory.
-         */
-        $template_slug = apply_filters('gravityview_template_slug_'.$view->settings->get('template'), 'table', 'directory');
-
-        /**
-         * Figure out whether to get the entries or not.
-         *
-         * Some contexts don't need initial entries, like the DataTables directory type.
-         *
-         * @filter `gravityview_get_view_entries_{$template_slug}` Whether to get the entries or not.
-         *
-         * @param bool $get_entries Get entries or not, default: true.
-         */
-        $get_entries = apply_filters('gravityview_get_view_entries_'.$template_slug, true);
-
-        $hide_until_searched = $view->settings->get('hide_until_searched');
-
-        /**
-         * Hide View data until search is performed.
-         */
-        $get_entries = ($hide_until_searched && !$request->is_search()) ? false : $get_entries;
-
-        /**
-         * Fetch entries for this View.
-         */
-        if ($get_entries) {
-            $entries = $view->get_entries($request);
-        } else {
-            $entries = new \GV\Entry_Collection();
-        }
-
-        /**
-         * Load a legacy override template if exists.
-         */
-        $override = new \GV\Legacy_Override_Template($view, null, null, $request);
-        foreach (['header', 'body', 'footer'] as $part) {
-            if (($path = $override->get_template_part($template_slug, $part)) && strpos($path, '/deprecated') === false) {
-                /**
-                 * We have to bail and call the legacy renderer. Crap!
-                 */
-                gravityview()->log->notice('Legacy templates detected in theme {path}', ['path' => $path]);
-
-                /**
-                 * Show a warning at the top, if View is editable by the user.
-                 */
-                add_action('gravityview_before', $this->legacy_template_warning($view, $path));
-
-                return $override->render($template_slug);
-            }
-        }
-
-        /**
-         * @filter `gravityview/template/view/class` Filter the template class that is about to be used to render the view.
-         *
-         * @since 2.0
-         *
-         * @param string      $class   The chosen class - Default: \GV\View_Table_Template.
-         * @param \GV\View    $view    The view about to be rendered.
-         * @param \GV\Request $request The associated request.
-         */
-        $class = apply_filters('gravityview/template/view/class', sprintf('\GV\View_%s_Template', ucfirst($template_slug)), $view, $request);
-        if (!$class || !class_exists($class)) {
-            gravityview()->log->notice('{template_class} not found, falling back to legacy', ['template_class' => $class]);
-            $class = '\GV\View_Legacy_Template';
-        }
-        $template = new $class($view, $entries, $request);
-
-        /**
-         * Remove multiple sorting before calling legacy filters.
-         * This allows us to fake it till we make it.
-         */
-        $parameters = $view->settings->as_atts();
-        if (!empty($parameters['sort_field']) && is_array($parameters['sort_field'])) {
-            $has_multisort = true;
-            $parameters['sort_field'] = reset($parameters['sort_field']);
-            if (!empty($parameters['sort_direction']) && is_array($parameters['sort_direction'])) {
-                $parameters['sort_direction'] = reset($parameters['sort_direction']);
-            }
-        }
-
-        /** @todo Deprecate this! */
-        $parameters = \GravityView_frontend::get_view_entries_parameters($parameters, $view->form->ID);
-
-        global $post;
-
-        /** Mock the legacy state for the widgets and whatnot */
-        \GV\Mocks\Legacy_Context::push(array_merge([
-            'view'    => $view,
-            'entries' => $entries,
-            'request' => $request,
-        ], empty($parameters) ? [] : [
-            'paging'  => $parameters['paging'],
-            'sorting' => $parameters['sorting'],
-        ], empty($post) ? [] : [
-            'post' => $post,
-        ]));
-
-        add_action('gravityview/template/after', $view_id_output = function ($context) {
-            printf('<input type="hidden" class="gravityview-view-id" value="%d">', $context->view->ID);
-        });
-
-        ob_start();
-        $template->render();
-
-        remove_action('gravityview/template/after', $view_id_output);
-
-        \GV\Mocks\Legacy_Context::pop();
-
-        return ob_get_clean();
-    }
+	/**
+	 * Renders a \GV\View instance.
+	 *
+	 * @param \GV\View    $view    The View instance to render.
+	 * @param \GV\Request $request The request context we're currently in. Default: `gravityview()->request`
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return string The rendered View.
+	 */
+	public function render(View $view, Request $request = null)
+	{
+		if (is_null($request)) {
+			$request = &gravityview()->request;
+		}
+
+		if (!$request->is_renderable()) {
+			gravityview()->log->error('Renderer unable to render View in {request_class} context', ['request_class' => get_class($request)]);
+
+			return null;
+		}
+
+		/**
+		 * @filter `gravityview_template_slug_{$template_id}` Modify the template slug about to be loaded in directory views.
+		 *
+		 * @since 1.6
+		 * @deprecated
+		 * @see The `gravityview_get_template_id` filter
+		 *
+		 * @param string $slug Default: 'table'
+		 * @param string $view The current view context: directory.
+		 */
+		$template_slug = apply_filters('gravityview_template_slug_'.$view->settings->get('template'), 'table', 'directory');
+
+		/**
+		 * Figure out whether to get the entries or not.
+		 *
+		 * Some contexts don't need initial entries, like the DataTables directory type.
+		 *
+		 * @filter `gravityview_get_view_entries_{$template_slug}` Whether to get the entries or not.
+		 *
+		 * @param bool $get_entries Get entries or not, default: true.
+		 */
+		$get_entries = apply_filters('gravityview_get_view_entries_'.$template_slug, true);
+
+		$hide_until_searched = $view->settings->get('hide_until_searched');
+
+		/**
+		 * Hide View data until search is performed.
+		 */
+		$get_entries = ($hide_until_searched && !$request->is_search()) ? false : $get_entries;
+
+		/**
+		 * Fetch entries for this View.
+		 */
+		if ($get_entries) {
+			$entries = $view->get_entries($request);
+		} else {
+			$entries = new \GV\Entry_Collection();
+		}
+
+		/**
+		 * Load a legacy override template if exists.
+		 */
+		$override = new \GV\Legacy_Override_Template($view, null, null, $request);
+		foreach (['header', 'body', 'footer'] as $part) {
+			if (($path = $override->get_template_part($template_slug, $part)) && strpos($path, '/deprecated') === false) {
+				/**
+				 * We have to bail and call the legacy renderer. Crap!
+				 */
+				gravityview()->log->notice('Legacy templates detected in theme {path}', ['path' => $path]);
+
+				/**
+				 * Show a warning at the top, if View is editable by the user.
+				 */
+				add_action('gravityview_before', $this->legacy_template_warning($view, $path));
+
+				return $override->render($template_slug);
+			}
+		}
+
+		/**
+		 * @filter `gravityview/template/view/class` Filter the template class that is about to be used to render the view.
+		 *
+		 * @since 2.0
+		 *
+		 * @param string      $class   The chosen class - Default: \GV\View_Table_Template.
+		 * @param \GV\View    $view    The view about to be rendered.
+		 * @param \GV\Request $request The associated request.
+		 */
+		$class = apply_filters('gravityview/template/view/class', sprintf('\GV\View_%s_Template', ucfirst($template_slug)), $view, $request);
+		if (!$class || !class_exists($class)) {
+			gravityview()->log->notice('{template_class} not found, falling back to legacy', ['template_class' => $class]);
+			$class = '\GV\View_Legacy_Template';
+		}
+		$template = new $class($view, $entries, $request);
+
+		/**
+		 * Remove multiple sorting before calling legacy filters.
+		 * This allows us to fake it till we make it.
+		 */
+		$parameters = $view->settings->as_atts();
+		if (!empty($parameters['sort_field']) && is_array($parameters['sort_field'])) {
+			$has_multisort = true;
+			$parameters['sort_field'] = reset($parameters['sort_field']);
+			if (!empty($parameters['sort_direction']) && is_array($parameters['sort_direction'])) {
+				$parameters['sort_direction'] = reset($parameters['sort_direction']);
+			}
+		}
+
+		/** @todo Deprecate this! */
+		$parameters = \GravityView_frontend::get_view_entries_parameters($parameters, $view->form->ID);
+
+		global $post;
+
+		/** Mock the legacy state for the widgets and whatnot */
+		\GV\Mocks\Legacy_Context::push(array_merge([
+			'view'    => $view,
+			'entries' => $entries,
+			'request' => $request,
+		], empty($parameters) ? [] : [
+			'paging'  => $parameters['paging'],
+			'sorting' => $parameters['sorting'],
+		], empty($post) ? [] : [
+			'post' => $post,
+		]));
+
+		add_action('gravityview/template/after', $view_id_output = function ($context) {
+			printf('<input type="hidden" class="gravityview-view-id" value="%d">', $context->view->ID);
+		});
+
+		ob_start();
+		$template->render();
+
+		remove_action('gravityview/template/after', $view_id_output);
+
+		\GV\Mocks\Legacy_Context::pop();
+
+		return ob_get_clean();
+	}
 }

Spacing +35 added lines, -35 removed lines

@@ -3,7 +3,7 @@ 
 namespace GV;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -26,14 +26,14 @@ 
      *
      * @return string The rendered View.
      */
-    public function render(View $view, Request $request = null)
+    public function render( View $view, Request $request = null )
     {
-        if (is_null($request)) {
+        if ( is_null( $request ) ) {
             $request = &gravityview()->request;
         }
 
-        if (!$request->is_renderable()) {
-            gravityview()->log->error('Renderer unable to render View in {request_class} context', ['request_class' => get_class($request)]);
+        if ( ! $request->is_renderable() ) {
+            gravityview()->log->error( 'Renderer unable to render View in {request_class} context', [ 'request_class' => get_class( $request ) ] );
 
             return null;
         }
@@ -48,7 +48,7 @@ 
          * @param string $slug Default: 'table'
          * @param string $view The current view context: directory.
          */
-        $template_slug = apply_filters('gravityview_template_slug_'.$view->settings->get('template'), 'table', 'directory');
+        $template_slug = apply_filters( 'gravityview_template_slug_' . $view->settings->get( 'template' ), 'table', 'directory' );
 
         /**
          * Figure out whether to get the entries or not.
@@ -59,20 +59,20 @@ 
          *
          * @param bool $get_entries Get entries or not, default: true.
          */
-        $get_entries = apply_filters('gravityview_get_view_entries_'.$template_slug, true);
+        $get_entries = apply_filters( 'gravityview_get_view_entries_' . $template_slug, true );
 
-        $hide_until_searched = $view->settings->get('hide_until_searched');
+        $hide_until_searched = $view->settings->get( 'hide_until_searched' );
 
         /**
          * Hide View data until search is performed.
          */
-        $get_entries = ($hide_until_searched && !$request->is_search()) ? false : $get_entries;
+        $get_entries = ( $hide_until_searched && ! $request->is_search() ) ? false : $get_entries;
 
         /**
          * Fetch entries for this View.
          */
-        if ($get_entries) {
-            $entries = $view->get_entries($request);
+        if ( $get_entries ) {
+            $entries = $view->get_entries( $request );
         } else {
             $entries = new \GV\Entry_Collection();
         }
@@ -80,20 +80,20 @@ 
         /**
          * Load a legacy override template if exists.
          */
-        $override = new \GV\Legacy_Override_Template($view, null, null, $request);
-        foreach (['header', 'body', 'footer'] as $part) {
-            if (($path = $override->get_template_part($template_slug, $part)) && strpos($path, '/deprecated') === false) {
+        $override = new \GV\Legacy_Override_Template( $view, null, null, $request );
+        foreach ( [ 'header', 'body', 'footer' ] as $part ) {
+            if ( ( $path = $override->get_template_part( $template_slug, $part ) ) && strpos( $path, '/deprecated' ) === false ) {
                 /**
                  * We have to bail and call the legacy renderer. Crap!
                  */
-                gravityview()->log->notice('Legacy templates detected in theme {path}', ['path' => $path]);
+                gravityview()->log->notice( 'Legacy templates detected in theme {path}', [ 'path' => $path ] );
 
                 /**
                  * Show a warning at the top, if View is editable by the user.
                  */
-                add_action('gravityview_before', $this->legacy_template_warning($view, $path));
+                add_action( 'gravityview_before', $this->legacy_template_warning( $view, $path ) );
 
-                return $override->render($template_slug);
+                return $override->render( $template_slug );
             }
         }
 
@@ -106,51 +106,51 @@ 
          * @param \GV\View    $view    The view about to be rendered.
          * @param \GV\Request $request The associated request.
          */
-        $class = apply_filters('gravityview/template/view/class', sprintf('\GV\View_%s_Template', ucfirst($template_slug)), $view, $request);
-        if (!$class || !class_exists($class)) {
-            gravityview()->log->notice('{template_class} not found, falling back to legacy', ['template_class' => $class]);
+        $class = apply_filters( 'gravityview/template/view/class', sprintf( '\GV\View_%s_Template', ucfirst( $template_slug ) ), $view, $request );
+        if ( ! $class || ! class_exists( $class ) ) {
+            gravityview()->log->notice( '{template_class} not found, falling back to legacy', [ 'template_class' => $class ] );
             $class = '\GV\View_Legacy_Template';
         }
-        $template = new $class($view, $entries, $request);
+        $template = new $class( $view, $entries, $request );
 
         /**
          * Remove multiple sorting before calling legacy filters.
          * This allows us to fake it till we make it.
          */
         $parameters = $view->settings->as_atts();
-        if (!empty($parameters['sort_field']) && is_array($parameters['sort_field'])) {
+        if ( ! empty( $parameters[ 'sort_field' ] ) && is_array( $parameters[ 'sort_field' ] ) ) {
             $has_multisort = true;
-            $parameters['sort_field'] = reset($parameters['sort_field']);
-            if (!empty($parameters['sort_direction']) && is_array($parameters['sort_direction'])) {
-                $parameters['sort_direction'] = reset($parameters['sort_direction']);
+            $parameters[ 'sort_field' ] = reset( $parameters[ 'sort_field' ] );
+            if ( ! empty( $parameters[ 'sort_direction' ] ) && is_array( $parameters[ 'sort_direction' ] ) ) {
+                $parameters[ 'sort_direction' ] = reset( $parameters[ 'sort_direction' ] );
             }
         }
 
         /** @todo Deprecate this! */
-        $parameters = \GravityView_frontend::get_view_entries_parameters($parameters, $view->form->ID);
+        $parameters = \GravityView_frontend::get_view_entries_parameters( $parameters, $view->form->ID );
 
         global $post;
 
         /** Mock the legacy state for the widgets and whatnot */
-        \GV\Mocks\Legacy_Context::push(array_merge([
+        \GV\Mocks\Legacy_Context::push( array_merge( [
             'view'    => $view,
             'entries' => $entries,
             'request' => $request,
-        ], empty($parameters) ? [] : [
-            'paging'  => $parameters['paging'],
-            'sorting' => $parameters['sorting'],
-        ], empty($post) ? [] : [
+        ], empty( $parameters ) ? [ ] : [
+            'paging'  => $parameters[ 'paging' ],
+            'sorting' => $parameters[ 'sorting' ],
+        ], empty( $post ) ? [ ] : [
             'post' => $post,
-        ]));
+        ] ) );
 
-        add_action('gravityview/template/after', $view_id_output = function ($context) {
-            printf('<input type="hidden" class="gravityview-view-id" value="%d">', $context->view->ID);
+        add_action( 'gravityview/template/after', $view_id_output = function( $context ) {
+            printf( '<input type="hidden" class="gravityview-view-id" value="%d">', $context->view->ID );
         });
 
         ob_start();
         $template->render();
 
-        remove_action('gravityview/template/after', $view_id_output);
+        remove_action( 'gravityview/template/after', $view_id_output );
 
         \GV\Mocks\Legacy_Context::pop();
 

Braces +2 added lines, -4 removed lines

@@ -12,8 +12,7 @@ 
  *
  * Houses some preliminary \GV\View rendering functionality.
  */
-class View_Renderer extends Renderer
-{
+class View_Renderer extends Renderer {
     /**
      * Renders a \GV\View instance.
      *
@@ -26,8 +25,7 @@ 
      *
      * @return string The rendered View.
      */
-    public function render(View $view, Request $request = null)
-    {
+    public function render(View $view, Request $request = null) {
         if (is_null($request)) {
             $request = &gravityview()->request;
         }

future/includes/class-gv-widget.php

Indentation +565 added lines, -565 removed lines

@@ -4,7 +4,7 @@ 
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 /**
@@ -14,568 +14,568 @@ 
  */
 abstract class Widget
 {
-    /**
-     * Widget admin label.
-     *
-     * @var string
-     */
-    protected $widget_label = '';
-
-    /**
-     * Widget description, shown on the "+ Add Widget" picker.
-     *
-     * @var string
-     */
-    protected $widget_description = '';
-
-    /**
-     * Widget details, shown in the widget modal.
-     *
-     * @since 1.8
-     *
-     * @var string
-     */
-    protected $widget_subtitle = '';
-
-    /**
-     * Widget admin ID.
-     *
-     * @var string
-     */
-    protected $widget_id = '';
-
-    /**
-     * Default configuration for header and footer.
-     *
-     * @var array
-     */
-    protected $defaults = [];
-
-    /**
-     * Widget admin advanced settings.
-     *
-     * @var array
-     */
-    protected $settings = [];
-
-    /**
-     * Allow class to automatically add widget_text filter for you in shortcode.
-     *
-     * @var string
-     */
-    protected $shortcode_name;
-
-    /**
-     * Hold the widget options.
-     *
-     * @var array()
-     */
-    private $widget_options = [];
-
-    /**
-     * The position of the widget.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @var string
-     */
-    public $position = '';
-
-    /**
-     * A unique ID for this widget.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @var string
-     */
-    public $UID = '';
-
-    /**
-     * The actual configuration for this widget instance.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @var \GV\Settings
-     */
-    public $configuration;
-
-    /**
-     * @var string An icon that represents the widget type in the widget picker.
-     *
-     * Supports these icon formats:
-     * - Gravity Forms icon class: The string starts with "gform-icon". Note: the site must be running GF 2.5+. No need to also pass "gform-icon".
-     * - Dashicons: The string starts with "dashicons". No need to also pass "dashicons".
-     * - Inline SVG: Starts with "data:"
-     * - If not matching those formats, the value will be used as a CSS class in a `<i>` element.
-     *
-     * @see GravityView_Admin_View_Item::getOutput
-     */
-    public $icon;
-
-    /**
-     * Constructor.
-     *
-     * @param string $label    The Widget label as shown in the admin.
-     * @param string $id       The Widget ID, make this something unique.
-     * @param array  $defaults Default footer/header Widget configuration.
-     * @param array  $settings Advanced Widget settings.
-     *
-     * @return \GV\Widget
-     */
-    public function __construct($label, $id, $defaults = [], $settings = [])
-    {
-        /**
-         * The shortcode name is set to the lowercase name of the widget class, unless overridden by the class specifying a different value for $shortcode_name.
-         *
-         * @var string
-         */
-        $this->shortcode_name = empty($this->shortcode_name) ? strtolower(get_called_class()) : $this->shortcode_name;
-
-        if ($id) {
-            $this->widget_id = $id;
-        }
-
-        $this->widget_label = $label;
-        $this->defaults = array_merge(['header' => 0, 'footer' => 0], $defaults);
-
-        // Make sure every widget has a title, even if empty
-        $this->settings = wp_parse_args($settings, $this->get_default_settings());
-
-        // Hook once per unique ID
-        if ($this->is_registered()) {
-            return;
-        }
-
-        // widget options
-        add_filter('gravityview_template_widget_options', [$this, 'assign_widget_options'], 10, 3);
-
-        // frontend logic
-        add_action(sprintf('gravityview/widgets/%s/render', $this->get_widget_id()), [$this, 'render_frontend'], 10, 3);
-
-        // register shortcodes
-        add_action('wp', [$this, 'add_shortcode']);
-
-        // Use shortcodes in text widgets.
-        add_filter('widget_text', [$this, 'maybe_do_shortcode']);
-
-        // register widgets to be listed in the View Configuration
-        // Important: this has to be the last filter/action added in the constructor.
-        add_filter('gravityview/widgets/register', [$this, 'register_widget']);
-    }
-
-    /**
-     * Define general widget settings.
-     *
-     * @since 1.5.4
-     *
-     * @return array $settings Default settings
-     */
-    protected function get_default_settings()
-    {
-        $settings = [];
-
-        /**
-         * @filter `gravityview/widget/enable_custom_class` Enable custom CSS class settings for widgets
-         *
-         * @param bool       $enable_custom_class False by default. Return true if you want to enable.
-         * @param \GV\Widget $this                Current instance of \GV\Widget.
-         */
-        $enable_custom_class = apply_filters('gravityview/widget/enable_custom_class', false, $this);
-
-        if ($enable_custom_class) {
-            $settings['custom_class'] = [
-                'type'       => 'text',
-                'label'      => __('Custom CSS Class:', 'gravityview'),
-                'desc'       => __('This class will be added to the widget container', 'gravityview'),
-                'value'      => '',
-                'merge_tags' => true,
-                'class'      => 'widefat code',
-            ];
-        }
-
-        return $settings;
-    }
-
-    /**
-     * Get the Widget ID.
-     *
-     * @return string The Widget ID.
-     */
-    public function get_widget_id()
-    {
-        return $this->widget_id;
-    }
-
-    /**
-     * Get the widget settings.
-     *
-     * @return array|null Settings array; NULL if not set for some reason.
-     */
-    public function get_settings()
-    {
-        return empty($this->settings) ? null : $this->settings;
-    }
-
-    /**
-     * Get a setting by the setting key.
-     *
-     * @param string $key Key for the setting
-     *
-     * @todo Use the \GV\Settings class later. For now subclasses may still expect and array instead.
-     *
-     * @return mixed|null Value of the setting; NULL if not set
-     */
-    public function get_setting($key)
-    {
-        return Utils::get($this->settings, $key, null);
-    }
-
-    /**
-     * Default widget areas.
-     *
-     * Usually overridden by the selected template.
-     *
-     * @return array The default areas where widgets can be rendered.
-     */
-    public static function get_default_widget_areas()
-    {
-        $default_areas = [
-            [
-                '1-1' => [
-                    [
-                        'areaid'   => 'top',
-                        'title'    => __('Top', 'gravityview'),
-                        'subtitle' => '',
-                    ],
-                ],
-            ],
-            [
-                '1-2' => [
-                    [
-                        'areaid'   => 'left',
-                        'title'    => __('Left', 'gravityview'),
-                        'subtitle' => '',
-                    ],
-                ],
-                '2-2' => [
-                    [
-                        'areaid'   => 'right',
-                        'title'    => __('Right', 'gravityview'),
-                        'subtitle' => '',
-                    ],
-                ],
-            ],
-        ];
-
-        /**
-         * @filter `gravityview_widget_active_areas` Array of zones available for widgets to be dropped into
-         *
-         * @deprecated 2.0: Use gravityview/widget/active_areas instead
-         *
-         * @param array $default_areas Definition for default widget areas
-         */
-        $default_areas = apply_filters('gravityview_widget_active_areas', $default_areas);
-
-        /**
-         * @filter `gravityview/widget/active_areas` Array of zones available for widgets to be dropped into
-         *
-         * @since 2.0
-         *
-         * @param array $default_areas Definition for default widget areas
-         */
-        return apply_filters('gravityview/widget/active_areas', $default_areas);
-    }
-
-    /**
-     * Register widget to become available in admin. And for lookup.
-     *
-     * @param array $widgets Usually just empty. Used to gather them all up.
-     *
-     * @return array $widgets
-     */
-    public function register_widget($widgets)
-    {
-        if (!is_array($widgets)) {
-            $widgets = [];
-        }
-
-        $widgets[$this->get_widget_id()] = [
-            'label'       => $this->widget_label,
-            'description' => $this->widget_description,
-            'subtitle'    => $this->widget_subtitle,
-            'icon'        => $this->icon,
-            'class'       => get_called_class(),
-        ];
-
-        return $widgets;
-    }
-
-    /**
-     * Assign template specific widget options.
-     *
-     *
-     * @param array  $options  (default: array())
-     * @param string $template (default: '')
-     *
-     * @return array
-     */
-    public function assign_widget_options($options = [], $template = '', $widget = '')
-    {
-        if ($this->get_widget_id() === $widget) {
-            if ($settings = $this->get_settings()) {
-                $options = array_merge($options, $settings);
-            }
-        }
-
-        return $options;
-    }
-
-    /**
-     * Do shortcode if the Widget's shortcode exists.
-     *
-     * @param string $text Widget text to check
-     * @param  null|\WP_Widget Empty if not called by WP_Widget, or a WP_Widget instance
-     *
-     * @return string Widget text
-     */
-    public function maybe_do_shortcode($text, $widget = null)
-    {
-        if (!empty($this->shortcode_name) && has_shortcode($text, $this->shortcode_name)) {
-            return do_shortcode($text);
-        }
-
-        return $text;
-    }
-
-    /**
-     * Add $this->shortcode_name shortcode to output self::render_frontend().
-     *
-     * @return void
-     */
-    public function add_shortcode()
-    {
-        if (empty($this->shortcode_name)) {
-            return;
-        }
-
-        if (!gravityview()->plugin->is_compatible()) {
-            return;
-        }
-
-        if (gravityview()->request->is_admin()) {
-            return;
-        }
-
-        // If the widget shouldn't output on single entries, don't show it
-        if (empty($this->show_on_single) && gravityview()->request->is_entry()) {
-            gravityview()->log->debug('Skipping; set to not run on single entry.');
-            add_shortcode($this->shortcode_name, '__return_null');
-
-            return;
-        }
-
-        global $post;
-
-        if (!is_object($post) || empty($post->post_content) || !Shortcode::parse($post->post_content)) {
-            add_shortcode($this->shortcode_name, '__return_null');
-
-            return;
-        }
-
-        add_shortcode($this->shortcode_name, [$this, 'render_shortcode']);
-    }
-
-    /**
-     * Frontend logic.
-     *
-     * Override in child class.
-     *
-     * @param array                       $widget_args The Widget shortcode args.
-     * @param string                      $content     The content.
-     * @param string|\GV\Template_Context $context     The context, if available.
-     *
-     * @return void
-     */
-    public function render_frontend($widget_args, $content = '', $context = '')
-    {
-    }
-
-    /**
-     * General validations when rendering the widget.
-     *
-     * Always call this from your `render_frontend()` override!
-     *
-     * @return bool True: render frontend; False: don't render frontend
-     */
-    public function pre_render_frontend()
-    {
-
-        /**
-         * Assume shown regardless of hide_until_search setting.
-         */
-        $allowlist = [
-            'custom_content',
-        ];
-
-        /**
-         * @deprecated 2.14 In favor of allowlist.
-         */
-        $allowlist = apply_filters_deprecated('gravityview/widget/hide_until_searched/whitelist', [$allowlist], '2.14', 'gravityview/widget/hide_until_searched/allowlist');
-
-        /**
-         * @filter `gravityview/widget/hide_until_searched/allowlist` Some widgets have got to stay shown.
-         *
-         * @since 2.14
-         *
-         * @param string[] $allowlist The widget IDs that have to be shown by default.
-         */
-        $allowlist = apply_filters('gravityview/widget/hide_until_searched/allowlist', $allowlist);
-
-        if (($view = gravityview()->views->get()) && !in_array($this->get_widget_id(), $allowlist)) {
-            $hide_until_searched = $view->settings->get('hide_until_searched');
-        } else {
-            $hide_until_searched = false;
-        }
-
-        /**
-         * @filter `gravityview/widget/hide_until_searched` Modify whether to hide content until search
-         *
-         * @param bool       $hide_until_searched Hide until search?
-         * @param \GV\Widget $this                Widget instance
-         */
-        $hide_until_searched = apply_filters('gravityview/widget/hide_until_searched', $hide_until_searched, $this);
-
-        if ($hide_until_searched && !gravityview()->request->is_search()) {
-            gravityview()->log->debug('Hide View data until search is performed');
-
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Shortcode.
-     *
-     * @param array                       $atts    The Widget shortcode args.
-     * @param string                      $content The content.
-     * @param string|\GV\Template_Context $context The context, if available.
-     *
-     * @return string Whatever the widget echoed.
-     */
-    public function render_shortcode($atts, $content = '', $context = '')
-    {
-        ob_start();
-        $this->render_frontend($atts, $content, $context);
-
-        return ob_get_clean();
-    }
-
-    /**
-     * Create the needed widget from a configuration array.
-     *
-     * @param array $configuration The configuration array.
-     *
-     * @see \GV\Widget::as_configuration()
-     *
-     * @internal
-     *
-     * @since 2.0
-     *
-     * @return \GV\Widget|null The widget implementation from configuration or none.
-     */
-    public static function from_configuration($configuration)
-    {
-        $registered_widgets = self::registered();
-
-        if (!$id = Utils::get($configuration, 'id')) {
-            return null;
-        }
-
-        if (!$widget = Utils::get($registered_widgets, $id)) {
-            return null;
-        }
-
-        if (!class_exists($class = Utils::get($widget, 'class'))) {
-            return null;
-        }
-
-        $w = new $class(Utils::get($widget, 'label'), $id);
-        $w->configuration = new Settings($configuration);
-
-        return $w;
-    }
-
-    /**
-     * Return an array of the old format.
-     *
-     *  		'id' => string
-     *			+ whatever else specific fields may have
-     *
-     * @internal
-     *
-     * @since 2.0
-     *
-     * @return array
-     */
-    public function as_configuration()
-    {
-        return array_merge([
-            'id' => $this->get_widget_id(),
-        ], $this->configuration->all());
-    }
-
-    /**
-     * Return all registered widgets.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return array
-     */
-    public static function registered()
-    {
-        /**
-         * @filter `gravityview_register_directory_widgets` Get the list of registered widgets. Each item is used to instantiate a GravityView_Admin_View_Widget object
-         *
-         * @deprecated Use `gravityview/widgets/register`
-         *
-         * @param array $registered_widgets Empty array
-         */
-        $registered_widgets = apply_filters('gravityview_register_directory_widgets', []);
-
-        /**
-         * @filter `gravityview/widgets/register` Each item is used to instantiate a GravityView_Admin_View_Widget object
-         *
-         * @param array $registered_widgets Empty array
-         */
-        return apply_filters('gravityview/widgets/register', $registered_widgets);
-    }
-
-    /**
-     * Whether this Widget's been registered already or not.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return bool
-     */
-    public function is_registered()
-    {
-        if (!$widget_id = $this->get_widget_id()) {
-            gravityview()->log->warning('Widget ID not set before calling Widget::is_registered', ['data' => $this]);
-
-            return false;
-        }
-
-        return in_array($widget_id, array_keys(self::registered()), true);
-    }
+	/**
+	 * Widget admin label.
+	 *
+	 * @var string
+	 */
+	protected $widget_label = '';
+
+	/**
+	 * Widget description, shown on the "+ Add Widget" picker.
+	 *
+	 * @var string
+	 */
+	protected $widget_description = '';
+
+	/**
+	 * Widget details, shown in the widget modal.
+	 *
+	 * @since 1.8
+	 *
+	 * @var string
+	 */
+	protected $widget_subtitle = '';
+
+	/**
+	 * Widget admin ID.
+	 *
+	 * @var string
+	 */
+	protected $widget_id = '';
+
+	/**
+	 * Default configuration for header and footer.
+	 *
+	 * @var array
+	 */
+	protected $defaults = [];
+
+	/**
+	 * Widget admin advanced settings.
+	 *
+	 * @var array
+	 */
+	protected $settings = [];
+
+	/**
+	 * Allow class to automatically add widget_text filter for you in shortcode.
+	 *
+	 * @var string
+	 */
+	protected $shortcode_name;
+
+	/**
+	 * Hold the widget options.
+	 *
+	 * @var array()
+	 */
+	private $widget_options = [];
+
+	/**
+	 * The position of the widget.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @var string
+	 */
+	public $position = '';
+
+	/**
+	 * A unique ID for this widget.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @var string
+	 */
+	public $UID = '';
+
+	/**
+	 * The actual configuration for this widget instance.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @var \GV\Settings
+	 */
+	public $configuration;
+
+	/**
+	 * @var string An icon that represents the widget type in the widget picker.
+	 *
+	 * Supports these icon formats:
+	 * - Gravity Forms icon class: The string starts with "gform-icon". Note: the site must be running GF 2.5+. No need to also pass "gform-icon".
+	 * - Dashicons: The string starts with "dashicons". No need to also pass "dashicons".
+	 * - Inline SVG: Starts with "data:"
+	 * - If not matching those formats, the value will be used as a CSS class in a `<i>` element.
+	 *
+	 * @see GravityView_Admin_View_Item::getOutput
+	 */
+	public $icon;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $label    The Widget label as shown in the admin.
+	 * @param string $id       The Widget ID, make this something unique.
+	 * @param array  $defaults Default footer/header Widget configuration.
+	 * @param array  $settings Advanced Widget settings.
+	 *
+	 * @return \GV\Widget
+	 */
+	public function __construct($label, $id, $defaults = [], $settings = [])
+	{
+		/**
+		 * The shortcode name is set to the lowercase name of the widget class, unless overridden by the class specifying a different value for $shortcode_name.
+		 *
+		 * @var string
+		 */
+		$this->shortcode_name = empty($this->shortcode_name) ? strtolower(get_called_class()) : $this->shortcode_name;
+
+		if ($id) {
+			$this->widget_id = $id;
+		}
+
+		$this->widget_label = $label;
+		$this->defaults = array_merge(['header' => 0, 'footer' => 0], $defaults);
+
+		// Make sure every widget has a title, even if empty
+		$this->settings = wp_parse_args($settings, $this->get_default_settings());
+
+		// Hook once per unique ID
+		if ($this->is_registered()) {
+			return;
+		}
+
+		// widget options
+		add_filter('gravityview_template_widget_options', [$this, 'assign_widget_options'], 10, 3);
+
+		// frontend logic
+		add_action(sprintf('gravityview/widgets/%s/render', $this->get_widget_id()), [$this, 'render_frontend'], 10, 3);
+
+		// register shortcodes
+		add_action('wp', [$this, 'add_shortcode']);
+
+		// Use shortcodes in text widgets.
+		add_filter('widget_text', [$this, 'maybe_do_shortcode']);
+
+		// register widgets to be listed in the View Configuration
+		// Important: this has to be the last filter/action added in the constructor.
+		add_filter('gravityview/widgets/register', [$this, 'register_widget']);
+	}
+
+	/**
+	 * Define general widget settings.
+	 *
+	 * @since 1.5.4
+	 *
+	 * @return array $settings Default settings
+	 */
+	protected function get_default_settings()
+	{
+		$settings = [];
+
+		/**
+		 * @filter `gravityview/widget/enable_custom_class` Enable custom CSS class settings for widgets
+		 *
+		 * @param bool       $enable_custom_class False by default. Return true if you want to enable.
+		 * @param \GV\Widget $this                Current instance of \GV\Widget.
+		 */
+		$enable_custom_class = apply_filters('gravityview/widget/enable_custom_class', false, $this);
+
+		if ($enable_custom_class) {
+			$settings['custom_class'] = [
+				'type'       => 'text',
+				'label'      => __('Custom CSS Class:', 'gravityview'),
+				'desc'       => __('This class will be added to the widget container', 'gravityview'),
+				'value'      => '',
+				'merge_tags' => true,
+				'class'      => 'widefat code',
+			];
+		}
+
+		return $settings;
+	}
+
+	/**
+	 * Get the Widget ID.
+	 *
+	 * @return string The Widget ID.
+	 */
+	public function get_widget_id()
+	{
+		return $this->widget_id;
+	}
+
+	/**
+	 * Get the widget settings.
+	 *
+	 * @return array|null Settings array; NULL if not set for some reason.
+	 */
+	public function get_settings()
+	{
+		return empty($this->settings) ? null : $this->settings;
+	}
+
+	/**
+	 * Get a setting by the setting key.
+	 *
+	 * @param string $key Key for the setting
+	 *
+	 * @todo Use the \GV\Settings class later. For now subclasses may still expect and array instead.
+	 *
+	 * @return mixed|null Value of the setting; NULL if not set
+	 */
+	public function get_setting($key)
+	{
+		return Utils::get($this->settings, $key, null);
+	}
+
+	/**
+	 * Default widget areas.
+	 *
+	 * Usually overridden by the selected template.
+	 *
+	 * @return array The default areas where widgets can be rendered.
+	 */
+	public static function get_default_widget_areas()
+	{
+		$default_areas = [
+			[
+				'1-1' => [
+					[
+						'areaid'   => 'top',
+						'title'    => __('Top', 'gravityview'),
+						'subtitle' => '',
+					],
+				],
+			],
+			[
+				'1-2' => [
+					[
+						'areaid'   => 'left',
+						'title'    => __('Left', 'gravityview'),
+						'subtitle' => '',
+					],
+				],
+				'2-2' => [
+					[
+						'areaid'   => 'right',
+						'title'    => __('Right', 'gravityview'),
+						'subtitle' => '',
+					],
+				],
+			],
+		];
+
+		/**
+		 * @filter `gravityview_widget_active_areas` Array of zones available for widgets to be dropped into
+		 *
+		 * @deprecated 2.0: Use gravityview/widget/active_areas instead
+		 *
+		 * @param array $default_areas Definition for default widget areas
+		 */
+		$default_areas = apply_filters('gravityview_widget_active_areas', $default_areas);
+
+		/**
+		 * @filter `gravityview/widget/active_areas` Array of zones available for widgets to be dropped into
+		 *
+		 * @since 2.0
+		 *
+		 * @param array $default_areas Definition for default widget areas
+		 */
+		return apply_filters('gravityview/widget/active_areas', $default_areas);
+	}
+
+	/**
+	 * Register widget to become available in admin. And for lookup.
+	 *
+	 * @param array $widgets Usually just empty. Used to gather them all up.
+	 *
+	 * @return array $widgets
+	 */
+	public function register_widget($widgets)
+	{
+		if (!is_array($widgets)) {
+			$widgets = [];
+		}
+
+		$widgets[$this->get_widget_id()] = [
+			'label'       => $this->widget_label,
+			'description' => $this->widget_description,
+			'subtitle'    => $this->widget_subtitle,
+			'icon'        => $this->icon,
+			'class'       => get_called_class(),
+		];
+
+		return $widgets;
+	}
+
+	/**
+	 * Assign template specific widget options.
+	 *
+	 *
+	 * @param array  $options  (default: array())
+	 * @param string $template (default: '')
+	 *
+	 * @return array
+	 */
+	public function assign_widget_options($options = [], $template = '', $widget = '')
+	{
+		if ($this->get_widget_id() === $widget) {
+			if ($settings = $this->get_settings()) {
+				$options = array_merge($options, $settings);
+			}
+		}
+
+		return $options;
+	}
+
+	/**
+	 * Do shortcode if the Widget's shortcode exists.
+	 *
+	 * @param string $text Widget text to check
+	 * @param  null|\WP_Widget Empty if not called by WP_Widget, or a WP_Widget instance
+	 *
+	 * @return string Widget text
+	 */
+	public function maybe_do_shortcode($text, $widget = null)
+	{
+		if (!empty($this->shortcode_name) && has_shortcode($text, $this->shortcode_name)) {
+			return do_shortcode($text);
+		}
+
+		return $text;
+	}
+
+	/**
+	 * Add $this->shortcode_name shortcode to output self::render_frontend().
+	 *
+	 * @return void
+	 */
+	public function add_shortcode()
+	{
+		if (empty($this->shortcode_name)) {
+			return;
+		}
+
+		if (!gravityview()->plugin->is_compatible()) {
+			return;
+		}
+
+		if (gravityview()->request->is_admin()) {
+			return;
+		}
+
+		// If the widget shouldn't output on single entries, don't show it
+		if (empty($this->show_on_single) && gravityview()->request->is_entry()) {
+			gravityview()->log->debug('Skipping; set to not run on single entry.');
+			add_shortcode($this->shortcode_name, '__return_null');
+
+			return;
+		}
+
+		global $post;
+
+		if (!is_object($post) || empty($post->post_content) || !Shortcode::parse($post->post_content)) {
+			add_shortcode($this->shortcode_name, '__return_null');
+
+			return;
+		}
+
+		add_shortcode($this->shortcode_name, [$this, 'render_shortcode']);
+	}
+
+	/**
+	 * Frontend logic.
+	 *
+	 * Override in child class.
+	 *
+	 * @param array                       $widget_args The Widget shortcode args.
+	 * @param string                      $content     The content.
+	 * @param string|\GV\Template_Context $context     The context, if available.
+	 *
+	 * @return void
+	 */
+	public function render_frontend($widget_args, $content = '', $context = '')
+	{
+	}
+
+	/**
+	 * General validations when rendering the widget.
+	 *
+	 * Always call this from your `render_frontend()` override!
+	 *
+	 * @return bool True: render frontend; False: don't render frontend
+	 */
+	public function pre_render_frontend()
+	{
+
+		/**
+		 * Assume shown regardless of hide_until_search setting.
+		 */
+		$allowlist = [
+			'custom_content',
+		];
+
+		/**
+		 * @deprecated 2.14 In favor of allowlist.
+		 */
+		$allowlist = apply_filters_deprecated('gravityview/widget/hide_until_searched/whitelist', [$allowlist], '2.14', 'gravityview/widget/hide_until_searched/allowlist');
+
+		/**
+		 * @filter `gravityview/widget/hide_until_searched/allowlist` Some widgets have got to stay shown.
+		 *
+		 * @since 2.14
+		 *
+		 * @param string[] $allowlist The widget IDs that have to be shown by default.
+		 */
+		$allowlist = apply_filters('gravityview/widget/hide_until_searched/allowlist', $allowlist);
+
+		if (($view = gravityview()->views->get()) && !in_array($this->get_widget_id(), $allowlist)) {
+			$hide_until_searched = $view->settings->get('hide_until_searched');
+		} else {
+			$hide_until_searched = false;
+		}
+
+		/**
+		 * @filter `gravityview/widget/hide_until_searched` Modify whether to hide content until search
+		 *
+		 * @param bool       $hide_until_searched Hide until search?
+		 * @param \GV\Widget $this                Widget instance
+		 */
+		$hide_until_searched = apply_filters('gravityview/widget/hide_until_searched', $hide_until_searched, $this);
+
+		if ($hide_until_searched && !gravityview()->request->is_search()) {
+			gravityview()->log->debug('Hide View data until search is performed');
+
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Shortcode.
+	 *
+	 * @param array                       $atts    The Widget shortcode args.
+	 * @param string                      $content The content.
+	 * @param string|\GV\Template_Context $context The context, if available.
+	 *
+	 * @return string Whatever the widget echoed.
+	 */
+	public function render_shortcode($atts, $content = '', $context = '')
+	{
+		ob_start();
+		$this->render_frontend($atts, $content, $context);
+
+		return ob_get_clean();
+	}
+
+	/**
+	 * Create the needed widget from a configuration array.
+	 *
+	 * @param array $configuration The configuration array.
+	 *
+	 * @see \GV\Widget::as_configuration()
+	 *
+	 * @internal
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Widget|null The widget implementation from configuration or none.
+	 */
+	public static function from_configuration($configuration)
+	{
+		$registered_widgets = self::registered();
+
+		if (!$id = Utils::get($configuration, 'id')) {
+			return null;
+		}
+
+		if (!$widget = Utils::get($registered_widgets, $id)) {
+			return null;
+		}
+
+		if (!class_exists($class = Utils::get($widget, 'class'))) {
+			return null;
+		}
+
+		$w = new $class(Utils::get($widget, 'label'), $id);
+		$w->configuration = new Settings($configuration);
+
+		return $w;
+	}
+
+	/**
+	 * Return an array of the old format.
+	 *
+	 *  		'id' => string
+	 *			+ whatever else specific fields may have
+	 *
+	 * @internal
+	 *
+	 * @since 2.0
+	 *
+	 * @return array
+	 */
+	public function as_configuration()
+	{
+		return array_merge([
+			'id' => $this->get_widget_id(),
+		], $this->configuration->all());
+	}
+
+	/**
+	 * Return all registered widgets.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return array
+	 */
+	public static function registered()
+	{
+		/**
+		 * @filter `gravityview_register_directory_widgets` Get the list of registered widgets. Each item is used to instantiate a GravityView_Admin_View_Widget object
+		 *
+		 * @deprecated Use `gravityview/widgets/register`
+		 *
+		 * @param array $registered_widgets Empty array
+		 */
+		$registered_widgets = apply_filters('gravityview_register_directory_widgets', []);
+
+		/**
+		 * @filter `gravityview/widgets/register` Each item is used to instantiate a GravityView_Admin_View_Widget object
+		 *
+		 * @param array $registered_widgets Empty array
+		 */
+		return apply_filters('gravityview/widgets/register', $registered_widgets);
+	}
+
+	/**
+	 * Whether this Widget's been registered already or not.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return bool
+	 */
+	public function is_registered()
+	{
+		if (!$widget_id = $this->get_widget_id()) {
+			gravityview()->log->warning('Widget ID not set before calling Widget::is_registered', ['data' => $this]);
+
+			return false;
+		}
+
+		return in_array($widget_id, array_keys(self::registered()), true);
+	}
 }

Spacing +72 added lines, -72 removed lines

@@ -3,7 +3,7 @@ 
 namespace GV;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -49,14 +49,14 @@ 
      *
      * @var array
      */
-    protected $defaults = [];
+    protected $defaults = [ ];
 
     /**
      * Widget admin advanced settings.
      *
      * @var array
      */
-    protected $settings = [];
+    protected $settings = [ ];
 
     /**
      * Allow class to automatically add widget_text filter for you in shortcode.
@@ -70,7 +70,7 @@ 
      *
      * @var array()
      */
-    private $widget_options = [];
+    private $widget_options = [ ];
 
     /**
      * The position of the widget.
@@ -128,45 +128,45 @@ 
      *
      * @return \GV\Widget
      */
-    public function __construct($label, $id, $defaults = [], $settings = [])
+    public function __construct( $label, $id, $defaults = [ ], $settings = [ ] )
     {
         /**
          * The shortcode name is set to the lowercase name of the widget class, unless overridden by the class specifying a different value for $shortcode_name.
          *
          * @var string
          */
-        $this->shortcode_name = empty($this->shortcode_name) ? strtolower(get_called_class()) : $this->shortcode_name;
+        $this->shortcode_name = empty( $this->shortcode_name ) ? strtolower( get_called_class() ) : $this->shortcode_name;
 
-        if ($id) {
+        if ( $id ) {
             $this->widget_id = $id;
         }
 
         $this->widget_label = $label;
-        $this->defaults = array_merge(['header' => 0, 'footer' => 0], $defaults);
+        $this->defaults = array_merge( [ 'header' => 0, 'footer' => 0 ], $defaults );
 
         // Make sure every widget has a title, even if empty
-        $this->settings = wp_parse_args($settings, $this->get_default_settings());
+        $this->settings = wp_parse_args( $settings, $this->get_default_settings() );
 
         // Hook once per unique ID
-        if ($this->is_registered()) {
+        if ( $this->is_registered() ) {
             return;
         }
 
         // widget options
-        add_filter('gravityview_template_widget_options', [$this, 'assign_widget_options'], 10, 3);
+        add_filter( 'gravityview_template_widget_options', [ $this, 'assign_widget_options' ], 10, 3 );
 
         // frontend logic
-        add_action(sprintf('gravityview/widgets/%s/render', $this->get_widget_id()), [$this, 'render_frontend'], 10, 3);
+        add_action( sprintf( 'gravityview/widgets/%s/render', $this->get_widget_id() ), [ $this, 'render_frontend' ], 10, 3 );
 
         // register shortcodes
-        add_action('wp', [$this, 'add_shortcode']);
+        add_action( 'wp', [ $this, 'add_shortcode' ] );
 
         // Use shortcodes in text widgets.
-        add_filter('widget_text', [$this, 'maybe_do_shortcode']);
+        add_filter( 'widget_text', [ $this, 'maybe_do_shortcode' ] );
 
         // register widgets to be listed in the View Configuration
         // Important: this has to be the last filter/action added in the constructor.
-        add_filter('gravityview/widgets/register', [$this, 'register_widget']);
+        add_filter( 'gravityview/widgets/register', [ $this, 'register_widget' ] );
     }
 
     /**
@@ -178,7 +178,7 @@ 
      */
     protected function get_default_settings()
     {
-        $settings = [];
+        $settings = [ ];
 
         /**
          * @filter `gravityview/widget/enable_custom_class` Enable custom CSS class settings for widgets
@@ -186,13 +186,13 @@ 
          * @param bool       $enable_custom_class False by default. Return true if you want to enable.
          * @param \GV\Widget $this                Current instance of \GV\Widget.
          */
-        $enable_custom_class = apply_filters('gravityview/widget/enable_custom_class', false, $this);
+        $enable_custom_class = apply_filters( 'gravityview/widget/enable_custom_class', false, $this );
 
-        if ($enable_custom_class) {
-            $settings['custom_class'] = [
+        if ( $enable_custom_class ) {
+            $settings[ 'custom_class' ] = [
                 'type'       => 'text',
-                'label'      => __('Custom CSS Class:', 'gravityview'),
-                'desc'       => __('This class will be added to the widget container', 'gravityview'),
+                'label'      => __( 'Custom CSS Class:', 'gravityview' ),
+                'desc'       => __( 'This class will be added to the widget container', 'gravityview' ),
                 'value'      => '',
                 'merge_tags' => true,
                 'class'      => 'widefat code',
@@ -219,7 +219,7 @@ 
      */
     public function get_settings()
     {
-        return empty($this->settings) ? null : $this->settings;
+        return empty( $this->settings ) ? null : $this->settings;
     }
 
     /**
@@ -231,9 +231,9 @@ 
      *
      * @return mixed|null Value of the setting; NULL if not set
      */
-    public function get_setting($key)
+    public function get_setting( $key )
     {
-        return Utils::get($this->settings, $key, null);
+        return Utils::get( $this->settings, $key, null );
     }
 
     /**
@@ -250,7 +250,7 @@ 
                 '1-1' => [
                     [
                         'areaid'   => 'top',
-                        'title'    => __('Top', 'gravityview'),
+                        'title'    => __( 'Top', 'gravityview' ),
                         'subtitle' => '',
                     ],
                 ],
@@ -259,14 +259,14 @@ 
                 '1-2' => [
                     [
                         'areaid'   => 'left',
-                        'title'    => __('Left', 'gravityview'),
+                        'title'    => __( 'Left', 'gravityview' ),
                         'subtitle' => '',
                     ],
                 ],
                 '2-2' => [
                     [
                         'areaid'   => 'right',
-                        'title'    => __('Right', 'gravityview'),
+                        'title'    => __( 'Right', 'gravityview' ),
                         'subtitle' => '',
                     ],
                 ],
@@ -280,7 +280,7 @@ 
          *
          * @param array $default_areas Definition for default widget areas
          */
-        $default_areas = apply_filters('gravityview_widget_active_areas', $default_areas);
+        $default_areas = apply_filters( 'gravityview_widget_active_areas', $default_areas );
 
         /**
          * @filter `gravityview/widget/active_areas` Array of zones available for widgets to be dropped into
@@ -289,7 +289,7 @@ 
          *
          * @param array $default_areas Definition for default widget areas
          */
-        return apply_filters('gravityview/widget/active_areas', $default_areas);
+        return apply_filters( 'gravityview/widget/active_areas', $default_areas );
     }
 
     /**
@@ -299,13 +299,13 @@ 
      *
      * @return array $widgets
      */
-    public function register_widget($widgets)
+    public function register_widget( $widgets )
     {
-        if (!is_array($widgets)) {
-            $widgets = [];
+        if ( ! is_array( $widgets ) ) {
+            $widgets = [ ];
         }
 
-        $widgets[$this->get_widget_id()] = [
+        $widgets[ $this->get_widget_id() ] = [
             'label'       => $this->widget_label,
             'description' => $this->widget_description,
             'subtitle'    => $this->widget_subtitle,
@@ -325,11 +325,11 @@ 
      *
      * @return array
      */
-    public function assign_widget_options($options = [], $template = '', $widget = '')
+    public function assign_widget_options( $options = [ ], $template = '', $widget = '' )
     {
-        if ($this->get_widget_id() === $widget) {
-            if ($settings = $this->get_settings()) {
-                $options = array_merge($options, $settings);
+        if ( $this->get_widget_id() === $widget ) {
+            if ( $settings = $this->get_settings() ) {
+                $options = array_merge( $options, $settings );
             }
         }
 
@@ -344,10 +344,10 @@ 
      *
      * @return string Widget text
      */
-    public function maybe_do_shortcode($text, $widget = null)
+    public function maybe_do_shortcode( $text, $widget = null )
     {
-        if (!empty($this->shortcode_name) && has_shortcode($text, $this->shortcode_name)) {
-            return do_shortcode($text);
+        if ( ! empty( $this->shortcode_name ) && has_shortcode( $text, $this->shortcode_name ) ) {
+            return do_shortcode( $text );
         }
 
         return $text;
@@ -360,35 +360,35 @@ 
      */
     public function add_shortcode()
     {
-        if (empty($this->shortcode_name)) {
+        if ( empty( $this->shortcode_name ) ) {
             return;
         }
 
-        if (!gravityview()->plugin->is_compatible()) {
+        if ( ! gravityview()->plugin->is_compatible() ) {
             return;
         }
 
-        if (gravityview()->request->is_admin()) {
+        if ( gravityview()->request->is_admin() ) {
             return;
         }
 
         // If the widget shouldn't output on single entries, don't show it
-        if (empty($this->show_on_single) && gravityview()->request->is_entry()) {
-            gravityview()->log->debug('Skipping; set to not run on single entry.');
-            add_shortcode($this->shortcode_name, '__return_null');
+        if ( empty( $this->show_on_single ) && gravityview()->request->is_entry() ) {
+            gravityview()->log->debug( 'Skipping; set to not run on single entry.' );
+            add_shortcode( $this->shortcode_name, '__return_null' );
 
             return;
         }
 
         global $post;
 
-        if (!is_object($post) || empty($post->post_content) || !Shortcode::parse($post->post_content)) {
-            add_shortcode($this->shortcode_name, '__return_null');
+        if ( ! is_object( $post ) || empty( $post->post_content ) || ! Shortcode::parse( $post->post_content ) ) {
+            add_shortcode( $this->shortcode_name, '__return_null' );
 
             return;
         }
 
-        add_shortcode($this->shortcode_name, [$this, 'render_shortcode']);
+        add_shortcode( $this->shortcode_name, [ $this, 'render_shortcode' ] );
     }
 
     /**
@@ -402,7 +402,7 @@ 
      *
      * @return void
      */
-    public function render_frontend($widget_args, $content = '', $context = '')
+    public function render_frontend( $widget_args, $content = '', $context = '' )
     {
     }
 
@@ -426,7 +426,7 @@ 
         /**
          * @deprecated 2.14 In favor of allowlist.
          */
-        $allowlist = apply_filters_deprecated('gravityview/widget/hide_until_searched/whitelist', [$allowlist], '2.14', 'gravityview/widget/hide_until_searched/allowlist');
+        $allowlist = apply_filters_deprecated( 'gravityview/widget/hide_until_searched/whitelist', [ $allowlist ], '2.14', 'gravityview/widget/hide_until_searched/allowlist' );
 
         /**
          * @filter `gravityview/widget/hide_until_searched/allowlist` Some widgets have got to stay shown.
@@ -435,10 +435,10 @@ 
          *
          * @param string[] $allowlist The widget IDs that have to be shown by default.
          */
-        $allowlist = apply_filters('gravityview/widget/hide_until_searched/allowlist', $allowlist);
+        $allowlist = apply_filters( 'gravityview/widget/hide_until_searched/allowlist', $allowlist );
 
-        if (($view = gravityview()->views->get()) && !in_array($this->get_widget_id(), $allowlist)) {
-            $hide_until_searched = $view->settings->get('hide_until_searched');
+        if ( ( $view = gravityview()->views->get() ) && ! in_array( $this->get_widget_id(), $allowlist ) ) {
+            $hide_until_searched = $view->settings->get( 'hide_until_searched' );
         } else {
             $hide_until_searched = false;
         }
@@ -449,10 +449,10 @@ 
          * @param bool       $hide_until_searched Hide until search?
          * @param \GV\Widget $this                Widget instance
          */
-        $hide_until_searched = apply_filters('gravityview/widget/hide_until_searched', $hide_until_searched, $this);
+        $hide_until_searched = apply_filters( 'gravityview/widget/hide_until_searched', $hide_until_searched, $this );
 
-        if ($hide_until_searched && !gravityview()->request->is_search()) {
-            gravityview()->log->debug('Hide View data until search is performed');
+        if ( $hide_until_searched && ! gravityview()->request->is_search() ) {
+            gravityview()->log->debug( 'Hide View data until search is performed' );
 
             return false;
         }
@@ -469,10 +469,10 @@ 
      *
      * @return string Whatever the widget echoed.
      */
-    public function render_shortcode($atts, $content = '', $context = '')
+    public function render_shortcode( $atts, $content = '', $context = '' )
     {
         ob_start();
-        $this->render_frontend($atts, $content, $context);
+        $this->render_frontend( $atts, $content, $context );
 
         return ob_get_clean();
     }
@@ -490,24 +490,24 @@ 
      *
      * @return \GV\Widget|null The widget implementation from configuration or none.
      */
-    public static function from_configuration($configuration)
+    public static function from_configuration( $configuration )
     {
         $registered_widgets = self::registered();
 
-        if (!$id = Utils::get($configuration, 'id')) {
+        if ( ! $id = Utils::get( $configuration, 'id' ) ) {
             return null;
         }
 
-        if (!$widget = Utils::get($registered_widgets, $id)) {
+        if ( ! $widget = Utils::get( $registered_widgets, $id ) ) {
             return null;
         }
 
-        if (!class_exists($class = Utils::get($widget, 'class'))) {
+        if ( ! class_exists( $class = Utils::get( $widget, 'class' ) ) ) {
             return null;
         }
 
-        $w = new $class(Utils::get($widget, 'label'), $id);
-        $w->configuration = new Settings($configuration);
+        $w = new $class( Utils::get( $widget, 'label' ), $id );
+        $w->configuration = new Settings( $configuration );
 
         return $w;
     }
@@ -526,9 +526,9 @@ 
      */
     public function as_configuration()
     {
-        return array_merge([
+        return array_merge( [
             'id' => $this->get_widget_id(),
-        ], $this->configuration->all());
+        ], $this->configuration->all() );
     }
 
     /**
@@ -549,14 +549,14 @@ 
          *
          * @param array $registered_widgets Empty array
          */
-        $registered_widgets = apply_filters('gravityview_register_directory_widgets', []);
+        $registered_widgets = apply_filters( 'gravityview_register_directory_widgets', [ ] );
 
         /**
          * @filter `gravityview/widgets/register` Each item is used to instantiate a GravityView_Admin_View_Widget object
          *
          * @param array $registered_widgets Empty array
          */
-        return apply_filters('gravityview/widgets/register', $registered_widgets);
+        return apply_filters( 'gravityview/widgets/register', $registered_widgets );
     }
 
     /**
@@ -570,12 +570,12 @@ 
      */
     public function is_registered()
     {
-        if (!$widget_id = $this->get_widget_id()) {
-            gravityview()->log->warning('Widget ID not set before calling Widget::is_registered', ['data' => $this]);
+        if ( ! $widget_id = $this->get_widget_id() ) {
+            gravityview()->log->warning( 'Widget ID not set before calling Widget::is_registered', [ 'data' => $this ] );
 
             return false;
         }
 
-        return in_array($widget_id, array_keys(self::registered()), true);
+        return in_array( $widget_id, array_keys( self::registered() ), true );
     }
 }

Braces +18 added lines, -36 removed lines

@@ -12,8 +12,7 @@ 
  *
  * An interface that most GravityView widgets would want to adhere to and inherit from.
  */
-abstract class Widget
-{
+abstract class Widget {
     /**
      * Widget admin label.
      *
@@ -128,8 +127,7 @@ 
      *
      * @return \GV\Widget
      */
-    public function __construct($label, $id, $defaults = [], $settings = [])
-    {
+    public function __construct($label, $id, $defaults = [], $settings = []) {
         /**
          * The shortcode name is set to the lowercase name of the widget class, unless overridden by the class specifying a different value for $shortcode_name.
          *
@@ -176,8 +174,7 @@ 
      *
      * @return array $settings Default settings
      */
-    protected function get_default_settings()
-    {
+    protected function get_default_settings() {
         $settings = [];
 
         /**
@@ -207,8 +204,7 @@ 
      *
      * @return string The Widget ID.
      */
-    public function get_widget_id()
-    {
+    public function get_widget_id() {
         return $this->widget_id;
     }
 
@@ -217,8 +213,7 @@ 
      *
      * @return array|null Settings array; NULL if not set for some reason.
      */
-    public function get_settings()
-    {
+    public function get_settings() {
         return empty($this->settings) ? null : $this->settings;
     }
 
@@ -231,8 +226,7 @@ 
      *
      * @return mixed|null Value of the setting; NULL if not set
      */
-    public function get_setting($key)
-    {
+    public function get_setting($key) {
         return Utils::get($this->settings, $key, null);
     }
 
@@ -243,8 +237,7 @@ 
      *
      * @return array The default areas where widgets can be rendered.
      */
-    public static function get_default_widget_areas()
-    {
+    public static function get_default_widget_areas() {
         $default_areas = [
             [
                 '1-1' => [
@@ -299,8 +292,7 @@ 
      *
      * @return array $widgets
      */
-    public function register_widget($widgets)
-    {
+    public function register_widget($widgets) {
         if (!is_array($widgets)) {
             $widgets = [];
         }
@@ -325,8 +317,7 @@ 
      *
      * @return array
      */
-    public function assign_widget_options($options = [], $template = '', $widget = '')
-    {
+    public function assign_widget_options($options = [], $template = '', $widget = '') {
         if ($this->get_widget_id() === $widget) {
             if ($settings = $this->get_settings()) {
                 $options = array_merge($options, $settings);
@@ -344,8 +335,7 @@ 
      *
      * @return string Widget text
      */
-    public function maybe_do_shortcode($text, $widget = null)
-    {
+    public function maybe_do_shortcode($text, $widget = null) {
         if (!empty($this->shortcode_name) && has_shortcode($text, $this->shortcode_name)) {
             return do_shortcode($text);
         }
@@ -358,8 +348,7 @@ 
      *
      * @return void
      */
-    public function add_shortcode()
-    {
+    public function add_shortcode() {
         if (empty($this->shortcode_name)) {
             return;
         }
@@ -402,8 +391,7 @@ 
      *
      * @return void
      */
-    public function render_frontend($widget_args, $content = '', $context = '')
-    {
+    public function render_frontend($widget_args, $content = '', $context = '') {
     }
 
     /**
@@ -413,8 +401,7 @@ 
      *
      * @return bool True: render frontend; False: don't render frontend
      */
-    public function pre_render_frontend()
-    {
+    public function pre_render_frontend() {
 
         /**
          * Assume shown regardless of hide_until_search setting.
@@ -469,8 +456,7 @@ 
      *
      * @return string Whatever the widget echoed.
      */
-    public function render_shortcode($atts, $content = '', $context = '')
-    {
+    public function render_shortcode($atts, $content = '', $context = '') {
         ob_start();
         $this->render_frontend($atts, $content, $context);
 
@@ -490,8 +476,7 @@ 
      *
      * @return \GV\Widget|null The widget implementation from configuration or none.
      */
-    public static function from_configuration($configuration)
-    {
+    public static function from_configuration($configuration) {
         $registered_widgets = self::registered();
 
         if (!$id = Utils::get($configuration, 'id')) {
@@ -524,8 +509,7 @@ 
      *
      * @return array
      */
-    public function as_configuration()
-    {
+    public function as_configuration() {
         return array_merge([
             'id' => $this->get_widget_id(),
         ], $this->configuration->all());
@@ -540,8 +524,7 @@ 
      *
      * @return array
      */
-    public static function registered()
-    {
+    public static function registered() {
         /**
          * @filter `gravityview_register_directory_widgets` Get the list of registered widgets. Each item is used to instantiate a GravityView_Admin_View_Widget object
          *
@@ -568,8 +551,7 @@ 
      *
      * @return bool
      */
-    public function is_registered()
-    {
+    public function is_registered() {
         if (!$widget_id = $this->get_widget_id()) {
             gravityview()->log->warning('Widget ID not set before calling Widget::is_registered', ['data' => $this]);
 

future/includes/class-gv-collection-entry.php

Indentation +407 added lines, -407 removed lines

@@ -4,7 +4,7 @@ 
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 /**
@@ -12,410 +12,410 @@ 
  */
 class Entry_Collection extends Collection
 {
-    /**
-     * Lazy fetching and counting of data defers
-     *  all processing of entries and entry data until
-     *  it is really requested.
-     *
-     * @see \GV\Entry_Collection::add_fetch_callback
-     * @see \GV\Entry_Collection::add_count_callback
-     *
-     * @var array Lazy data loading callbacks.
-     */
-    private $callbacks = [];
-
-    /**
-     * @var \GV\Entry_Filter[] Filtering criteria.
-     */
-    public $filters = [];
-
-    /**
-     * @var \GV\Entry_Sort[] Sorting criteria.
-     */
-    public $sorts = [];
-
-    /**
-     * @var int The offset.
-     */
-    public $offset = 0;
-
-    /**
-     * @var int The limit.
-     */
-    public $limit = 20;
-
-    /**
-     * @var int The current page.
-     */
-    public $current_page = 1;
-
-    /**
-     * @var int The number of entries fetched.
-     */
-    private $fetched = -1;
-
-    /**
-     * Add an \GV\Entry to this collection.
-     *
-     * @param \GV\Entry $entry The entry to add to the internal array.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return void
-     */
-    public function add($entry)
-    {
-        if (!$entry instanceof Entry) {
-            $this->fetched = max(0, $this->fetched);
-            gravityview()->log->error('Entry_Collections can only contain objects of type \GV\Entry.');
-
-            return;
-        }
-        parent::add($entry);
-        $this->fetched = max(1, $this->fetched + 1);
-    }
-
-    /**
-     * Get a \GV\Entry from this list.
-     *
-     * @param int    $entry_id The ID of the entry to get.
-     * @param string $backend  The form backend identifier, allows for multiple form backends in the future. Unused until then.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry|null The \GV\entry with the $entry_id as the ID, or null if not found.
-     */
-    public function get($entry_id, $backend = 'gravityforms')
-    {
-        foreach ($this->all() as $entry) {
-            if ($entry->ID == $entry_id) {
-                return $entry;
-            }
-        }
-
-        return null;
-    }
-
-    /**
-     * Count the total number of \GV\Entry objects that are possible to get.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return int The total number of entries that are fetchable.
-     */
-    public function total()
-    {
-        $total = 0;
-
-        /** Call all lazy callbacks. */
-        foreach ($this->callbacks as $callback) {
-            if ($callback[0] != 'count') {
-                continue;
-            }
-
-            $total += $callback[1]($this->filters);
-        }
-
-        if (!$total) {
-            $total = parent::count();
-        }
-
-        return $total - $this->offset;
-    }
-
-    /**
-     * Get the entries as an array.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry[] The entries as an array.
-     */
-    public function all()
-    {
-        if ($this->fetched >= 0 || parent::count()) {
-            return parent::all();
-        }
-
-        return $this->fetch()->all();
-    }
-
-    /**
-     * Pluck by key.
-     *
-     * @api
-     *
-     * @since develop
-     *
-     * @param string $key The key to pluck by.
-     *
-     * @return array The plucked values.
-     */
-    public function pluck($key)
-    {
-        $result = [];
-
-        foreach ($this->all() as $entry) {
-            $entry = $entry->as_entry();
-            $result[] = Utils::get($entry, $key, null);
-        }
-
-        return $result;
-    }
-
-    /**
-     * Get the last \GV\Entry in this collection.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry|null The last entry or null.
-     */
-    public function last()
-    {
-        if ($this->fetched >= 0 || parent::count()) {
-            return parent::last();
-        }
-
-        return $this->fetch()->last();
-    }
-
-    /**
-     * Get the first \GV\Entry in this collection.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry|null The first entry or null.
-     */
-    public function first()
-    {
-        if ($this->fetched >= 0 || parent::count()) {
-            return parent::first();
-        }
-
-        return $this->fetch()->first();
-    }
-
-    /**
-     * Hydrate this collection now.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry_Collection This collection, now hydrated.
-     */
-    public function fetch()
-    {
-        if ($this->fetched >= 0) {
-            return $this;
-        }
-
-        $this->clear();
-
-        /** Calculate the offsets. */
-        $offset = new \GV\Entry_Offset();
-        $offset->limit = $this->limit;
-        $offset->offset = ($this->limit * ($this->current_page - 1)) + $this->offset;
-
-        /** Call all lazy callbacks. */
-        foreach ($this->callbacks as $i => $callback) {
-            if ($callback[0] != 'fetch') {
-                continue;
-            }
-
-            $this->merge($callback[1]($this->filters, $this->sorts, $offset));
-        }
-
-        $this->fetched = parent::count();
-
-        return $this;
-    }
-
-    /**
-     * Apply a filter to the current collection.
-     *
-     * This operation is non-destructive as a copy of the collection is returned.
-     *
-     * @param \GV\Entry_Filter $filter The filter to be applied.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry_Collection A copy of the this collection with the filter applied.
-     */
-    public function filter(\GV\Entry_Filter $filter)
-    {
-        $collection = clone $this;
-        $collection->clear();
-
-        array_push($collection->filters, $filter);
-
-        return $collection;
-    }
-
-    /**
-     * Sort.
-     *
-     * @param \GV\Entry_Sort $sort The sort to apply to this collection.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry_Collection A copy of the this collection with the sort applied.
-     */
-    public function sort($sort)
-    {
-        $collection = clone $this;
-        $collection->clear();
-
-        array_push($collection->sorts, $sort);
-
-        return $collection;
-    }
-
-    /**
-     * Limit the fetch to a specified window.
-     *
-     * @param int $limit The limit.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry_Collection A copy of the this collection with the limit applied.
-     */
-    public function limit($limit)
-    {
-        $collection = clone $this;
-        $collection->clear();
-        $collection->limit = $limit;
-
-        return $collection;
-    }
-
-    /**
-     * Add an $offset to these entries.
-     *
-     * Useful, you know, for pagination and stuff. Not too useful directly.
-     *
-     * @see \GV\Entry_Collection::page()
-     *
-     * @param int $offset The number of entries to skip in the database.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
-     */
-    public function offset($offset)
-    {
-        $collection = clone $this;
-        $collection->clear();
-        $collection->offset = $offset;
-
-        return $collection;
-    }
-
-    /**
-     * Set the current page.
-     *
-     * @param int $page Set the current page to this page. Ends up agumenting the $offset in \GV\Entry_Offset
-     *
-     * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
-     */
-    public function page($page)
-    {
-        $collection = clone $this;
-        $collection->clear();
-        $collection->current_page = $page;
-
-        return $collection;
-    }
-
-    /**
-     * Defer fetching of data to the provided callable.
-     *
-     * The callback signature should be as follows:
-     *  \GV\Entry_Collection callback( \GV\Entry_Filter $filter, \GV\Entry_Sort $sort, \GV\Entry_Offset $offset );
-     *
-     * The methods that trigger the callback are:
-     * - \GV\Entry_Collection::fetch
-     *
-     * ::fetch is triggered via:
-     * - \GV\Entry_Collection::all
-     * - \GV\Entry_Collection::last
-     *
-     * @param callable $callback The callback to call when needed.
-     *
-     * @internal
-     *
-     * @since 2.0
-     *
-     * @return void
-     */
-    public function add_fetch_callback($callback)
-    {
-        $this->add_callback('fetch', $callback);
-    }
-
-    /**
-     * Defer counting of data to the provided callable.
-     *
-     * The callback signature should be as follows:
-     *  int callback( \GV\Entry_Filter $filter );
-     *
-     * The methods that trigger the callback are:
-     * - \GV\Entry_Collection::count
-     *
-     * @param callable $callback The callback to call when needed.
-     *
-     * @internal
-     *
-     * @since 2.0
-     *
-     * @return void
-     */
-    public function add_count_callback($callback)
-    {
-        $this->add_callback('count', $callback);
-    }
-
-    /**
-     * Add a callback for lazy loading/counting.
-     *
-     * @param callable $callback The callback to call when needed.
-     *
-     * @return void
-     */
-    private function add_callback($type, $callback)
-    {
-        if (!is_callable($callback)) {
-            return;
-        }
-
-        $this->callbacks[] = [$type, $callback];
-    }
-
-    /**
-     * @inheritdoc
-     */
-    public function clear()
-    {
-        $this->fetched = -1;
-        parent::clear();
-    }
+	/**
+	 * Lazy fetching and counting of data defers
+	 *  all processing of entries and entry data until
+	 *  it is really requested.
+	 *
+	 * @see \GV\Entry_Collection::add_fetch_callback
+	 * @see \GV\Entry_Collection::add_count_callback
+	 *
+	 * @var array Lazy data loading callbacks.
+	 */
+	private $callbacks = [];
+
+	/**
+	 * @var \GV\Entry_Filter[] Filtering criteria.
+	 */
+	public $filters = [];
+
+	/**
+	 * @var \GV\Entry_Sort[] Sorting criteria.
+	 */
+	public $sorts = [];
+
+	/**
+	 * @var int The offset.
+	 */
+	public $offset = 0;
+
+	/**
+	 * @var int The limit.
+	 */
+	public $limit = 20;
+
+	/**
+	 * @var int The current page.
+	 */
+	public $current_page = 1;
+
+	/**
+	 * @var int The number of entries fetched.
+	 */
+	private $fetched = -1;
+
+	/**
+	 * Add an \GV\Entry to this collection.
+	 *
+	 * @param \GV\Entry $entry The entry to add to the internal array.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return void
+	 */
+	public function add($entry)
+	{
+		if (!$entry instanceof Entry) {
+			$this->fetched = max(0, $this->fetched);
+			gravityview()->log->error('Entry_Collections can only contain objects of type \GV\Entry.');
+
+			return;
+		}
+		parent::add($entry);
+		$this->fetched = max(1, $this->fetched + 1);
+	}
+
+	/**
+	 * Get a \GV\Entry from this list.
+	 *
+	 * @param int    $entry_id The ID of the entry to get.
+	 * @param string $backend  The form backend identifier, allows for multiple form backends in the future. Unused until then.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry|null The \GV\entry with the $entry_id as the ID, or null if not found.
+	 */
+	public function get($entry_id, $backend = 'gravityforms')
+	{
+		foreach ($this->all() as $entry) {
+			if ($entry->ID == $entry_id) {
+				return $entry;
+			}
+		}
+
+		return null;
+	}
+
+	/**
+	 * Count the total number of \GV\Entry objects that are possible to get.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return int The total number of entries that are fetchable.
+	 */
+	public function total()
+	{
+		$total = 0;
+
+		/** Call all lazy callbacks. */
+		foreach ($this->callbacks as $callback) {
+			if ($callback[0] != 'count') {
+				continue;
+			}
+
+			$total += $callback[1]($this->filters);
+		}
+
+		if (!$total) {
+			$total = parent::count();
+		}
+
+		return $total - $this->offset;
+	}
+
+	/**
+	 * Get the entries as an array.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry[] The entries as an array.
+	 */
+	public function all()
+	{
+		if ($this->fetched >= 0 || parent::count()) {
+			return parent::all();
+		}
+
+		return $this->fetch()->all();
+	}
+
+	/**
+	 * Pluck by key.
+	 *
+	 * @api
+	 *
+	 * @since develop
+	 *
+	 * @param string $key The key to pluck by.
+	 *
+	 * @return array The plucked values.
+	 */
+	public function pluck($key)
+	{
+		$result = [];
+
+		foreach ($this->all() as $entry) {
+			$entry = $entry->as_entry();
+			$result[] = Utils::get($entry, $key, null);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Get the last \GV\Entry in this collection.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry|null The last entry or null.
+	 */
+	public function last()
+	{
+		if ($this->fetched >= 0 || parent::count()) {
+			return parent::last();
+		}
+
+		return $this->fetch()->last();
+	}
+
+	/**
+	 * Get the first \GV\Entry in this collection.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry|null The first entry or null.
+	 */
+	public function first()
+	{
+		if ($this->fetched >= 0 || parent::count()) {
+			return parent::first();
+		}
+
+		return $this->fetch()->first();
+	}
+
+	/**
+	 * Hydrate this collection now.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry_Collection This collection, now hydrated.
+	 */
+	public function fetch()
+	{
+		if ($this->fetched >= 0) {
+			return $this;
+		}
+
+		$this->clear();
+
+		/** Calculate the offsets. */
+		$offset = new \GV\Entry_Offset();
+		$offset->limit = $this->limit;
+		$offset->offset = ($this->limit * ($this->current_page - 1)) + $this->offset;
+
+		/** Call all lazy callbacks. */
+		foreach ($this->callbacks as $i => $callback) {
+			if ($callback[0] != 'fetch') {
+				continue;
+			}
+
+			$this->merge($callback[1]($this->filters, $this->sorts, $offset));
+		}
+
+		$this->fetched = parent::count();
+
+		return $this;
+	}
+
+	/**
+	 * Apply a filter to the current collection.
+	 *
+	 * This operation is non-destructive as a copy of the collection is returned.
+	 *
+	 * @param \GV\Entry_Filter $filter The filter to be applied.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry_Collection A copy of the this collection with the filter applied.
+	 */
+	public function filter(\GV\Entry_Filter $filter)
+	{
+		$collection = clone $this;
+		$collection->clear();
+
+		array_push($collection->filters, $filter);
+
+		return $collection;
+	}
+
+	/**
+	 * Sort.
+	 *
+	 * @param \GV\Entry_Sort $sort The sort to apply to this collection.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry_Collection A copy of the this collection with the sort applied.
+	 */
+	public function sort($sort)
+	{
+		$collection = clone $this;
+		$collection->clear();
+
+		array_push($collection->sorts, $sort);
+
+		return $collection;
+	}
+
+	/**
+	 * Limit the fetch to a specified window.
+	 *
+	 * @param int $limit The limit.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry_Collection A copy of the this collection with the limit applied.
+	 */
+	public function limit($limit)
+	{
+		$collection = clone $this;
+		$collection->clear();
+		$collection->limit = $limit;
+
+		return $collection;
+	}
+
+	/**
+	 * Add an $offset to these entries.
+	 *
+	 * Useful, you know, for pagination and stuff. Not too useful directly.
+	 *
+	 * @see \GV\Entry_Collection::page()
+	 *
+	 * @param int $offset The number of entries to skip in the database.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
+	 */
+	public function offset($offset)
+	{
+		$collection = clone $this;
+		$collection->clear();
+		$collection->offset = $offset;
+
+		return $collection;
+	}
+
+	/**
+	 * Set the current page.
+	 *
+	 * @param int $page Set the current page to this page. Ends up agumenting the $offset in \GV\Entry_Offset
+	 *
+	 * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
+	 */
+	public function page($page)
+	{
+		$collection = clone $this;
+		$collection->clear();
+		$collection->current_page = $page;
+
+		return $collection;
+	}
+
+	/**
+	 * Defer fetching of data to the provided callable.
+	 *
+	 * The callback signature should be as follows:
+	 *  \GV\Entry_Collection callback( \GV\Entry_Filter $filter, \GV\Entry_Sort $sort, \GV\Entry_Offset $offset );
+	 *
+	 * The methods that trigger the callback are:
+	 * - \GV\Entry_Collection::fetch
+	 *
+	 * ::fetch is triggered via:
+	 * - \GV\Entry_Collection::all
+	 * - \GV\Entry_Collection::last
+	 *
+	 * @param callable $callback The callback to call when needed.
+	 *
+	 * @internal
+	 *
+	 * @since 2.0
+	 *
+	 * @return void
+	 */
+	public function add_fetch_callback($callback)
+	{
+		$this->add_callback('fetch', $callback);
+	}
+
+	/**
+	 * Defer counting of data to the provided callable.
+	 *
+	 * The callback signature should be as follows:
+	 *  int callback( \GV\Entry_Filter $filter );
+	 *
+	 * The methods that trigger the callback are:
+	 * - \GV\Entry_Collection::count
+	 *
+	 * @param callable $callback The callback to call when needed.
+	 *
+	 * @internal
+	 *
+	 * @since 2.0
+	 *
+	 * @return void
+	 */
+	public function add_count_callback($callback)
+	{
+		$this->add_callback('count', $callback);
+	}
+
+	/**
+	 * Add a callback for lazy loading/counting.
+	 *
+	 * @param callable $callback The callback to call when needed.
+	 *
+	 * @return void
+	 */
+	private function add_callback($type, $callback)
+	{
+		if (!is_callable($callback)) {
+			return;
+		}
+
+		$this->callbacks[] = [$type, $callback];
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function clear()
+	{
+		$this->fetched = -1;
+		parent::clear();
+	}
 }

Spacing +43 added lines, -43 removed lines

@@ -3,7 +3,7 @@ 
 namespace GV;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -22,17 +22,17 @@ 
      *
      * @var array Lazy data loading callbacks.
      */
-    private $callbacks = [];
+    private $callbacks = [ ];
 
     /**
      * @var \GV\Entry_Filter[] Filtering criteria.
      */
-    public $filters = [];
+    public $filters = [ ];
 
     /**
      * @var \GV\Entry_Sort[] Sorting criteria.
      */
-    public $sorts = [];
+    public $sorts = [ ];
 
     /**
      * @var int The offset.
@@ -65,16 +65,16 @@ 
      *
      * @return void
      */
-    public function add($entry)
+    public function add( $entry )
     {
-        if (!$entry instanceof Entry) {
-            $this->fetched = max(0, $this->fetched);
-            gravityview()->log->error('Entry_Collections can only contain objects of type \GV\Entry.');
+        if ( ! $entry instanceof Entry ) {
+            $this->fetched = max( 0, $this->fetched );
+            gravityview()->log->error( 'Entry_Collections can only contain objects of type \GV\Entry.' );
 
             return;
         }
-        parent::add($entry);
-        $this->fetched = max(1, $this->fetched + 1);
+        parent::add( $entry );
+        $this->fetched = max( 1, $this->fetched + 1 );
     }
 
     /**
@@ -89,10 +89,10 @@ 
      *
      * @return \GV\Entry|null The \GV\entry with the $entry_id as the ID, or null if not found.
      */
-    public function get($entry_id, $backend = 'gravityforms')
+    public function get( $entry_id, $backend = 'gravityforms' )
     {
-        foreach ($this->all() as $entry) {
-            if ($entry->ID == $entry_id) {
+        foreach ( $this->all() as $entry ) {
+            if ( $entry->ID == $entry_id ) {
                 return $entry;
             }
         }
@@ -114,15 +114,15 @@ 
         $total = 0;
 
         /** Call all lazy callbacks. */
-        foreach ($this->callbacks as $callback) {
-            if ($callback[0] != 'count') {
+        foreach ( $this->callbacks as $callback ) {
+            if ( $callback[ 0 ] != 'count' ) {
                 continue;
             }
 
-            $total += $callback[1]($this->filters);
+            $total += $callback[ 1 ]( $this->filters );
         }
 
-        if (!$total) {
+        if ( ! $total ) {
             $total = parent::count();
         }
 
@@ -140,7 +140,7 @@ 
      */
     public function all()
     {
-        if ($this->fetched >= 0 || parent::count()) {
+        if ( $this->fetched >= 0 || parent::count() ) {
             return parent::all();
         }
 
@@ -158,13 +158,13 @@ 
      *
      * @return array The plucked values.
      */
-    public function pluck($key)
+    public function pluck( $key )
     {
-        $result = [];
+        $result = [ ];
 
-        foreach ($this->all() as $entry) {
+        foreach ( $this->all() as $entry ) {
             $entry = $entry->as_entry();
-            $result[] = Utils::get($entry, $key, null);
+            $result[ ] = Utils::get( $entry, $key, null );
         }
 
         return $result;
@@ -181,7 +181,7 @@ 
      */
     public function last()
     {
-        if ($this->fetched >= 0 || parent::count()) {
+        if ( $this->fetched >= 0 || parent::count() ) {
             return parent::last();
         }
 
@@ -199,7 +199,7 @@ 
      */
     public function first()
     {
-        if ($this->fetched >= 0 || parent::count()) {
+        if ( $this->fetched >= 0 || parent::count() ) {
             return parent::first();
         }
 
@@ -217,7 +217,7 @@ 
      */
     public function fetch()
     {
-        if ($this->fetched >= 0) {
+        if ( $this->fetched >= 0 ) {
             return $this;
         }
 
@@ -226,15 +226,15 @@ 
         /** Calculate the offsets. */
         $offset = new \GV\Entry_Offset();
         $offset->limit = $this->limit;
-        $offset->offset = ($this->limit * ($this->current_page - 1)) + $this->offset;
+        $offset->offset = ( $this->limit * ( $this->current_page - 1 ) ) + $this->offset;
 
         /** Call all lazy callbacks. */
-        foreach ($this->callbacks as $i => $callback) {
-            if ($callback[0] != 'fetch') {
+        foreach ( $this->callbacks as $i => $callback ) {
+            if ( $callback[ 0 ] != 'fetch' ) {
                 continue;
             }
 
-            $this->merge($callback[1]($this->filters, $this->sorts, $offset));
+            $this->merge( $callback[ 1 ]( $this->filters, $this->sorts, $offset ) );
         }
 
         $this->fetched = parent::count();
@@ -255,12 +255,12 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the filter applied.
      */
-    public function filter(\GV\Entry_Filter $filter)
+    public function filter( \GV\Entry_Filter $filter )
     {
         $collection = clone $this;
         $collection->clear();
 
-        array_push($collection->filters, $filter);
+        array_push( $collection->filters, $filter );
 
         return $collection;
     }
@@ -276,12 +276,12 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the sort applied.
      */
-    public function sort($sort)
+    public function sort( $sort )
     {
         $collection = clone $this;
         $collection->clear();
 
-        array_push($collection->sorts, $sort);
+        array_push( $collection->sorts, $sort );
 
         return $collection;
     }
@@ -297,7 +297,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the limit applied.
      */
-    public function limit($limit)
+    public function limit( $limit )
     {
         $collection = clone $this;
         $collection->clear();
@@ -321,7 +321,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
      */
-    public function offset($offset)
+    public function offset( $offset )
     {
         $collection = clone $this;
         $collection->clear();
@@ -337,7 +337,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
      */
-    public function page($page)
+    public function page( $page )
     {
         $collection = clone $this;
         $collection->clear();
@@ -367,9 +367,9 @@ 
      *
      * @return void
      */
-    public function add_fetch_callback($callback)
+    public function add_fetch_callback( $callback )
     {
-        $this->add_callback('fetch', $callback);
+        $this->add_callback( 'fetch', $callback );
     }
 
     /**
@@ -389,9 +389,9 @@ 
      *
      * @return void
      */
-    public function add_count_callback($callback)
+    public function add_count_callback( $callback )
     {
-        $this->add_callback('count', $callback);
+        $this->add_callback( 'count', $callback );
     }
 
     /**
@@ -401,13 +401,13 @@ 
      *
      * @return void
      */
-    private function add_callback($type, $callback)
+    private function add_callback( $type, $callback )
     {
-        if (!is_callable($callback)) {
+        if ( ! is_callable( $callback ) ) {
             return;
         }
 
-        $this->callbacks[] = [$type, $callback];
+        $this->callbacks[ ] = [ $type, $callback ];
     }
 
     /**

Braces +18 added lines, -36 removed lines

@@ -10,8 +10,7 @@ 
 /**
  * A collection of \GV\Entry objects.
  */
-class Entry_Collection extends Collection
-{
+class Entry_Collection extends Collection {
     /**
      * Lazy fetching and counting of data defers
      *  all processing of entries and entry data until
@@ -65,8 +64,7 @@ 
      *
      * @return void
      */
-    public function add($entry)
-    {
+    public function add($entry) {
         if (!$entry instanceof Entry) {
             $this->fetched = max(0, $this->fetched);
             gravityview()->log->error('Entry_Collections can only contain objects of type \GV\Entry.');
@@ -89,8 +87,7 @@ 
      *
      * @return \GV\Entry|null The \GV\entry with the $entry_id as the ID, or null if not found.
      */
-    public function get($entry_id, $backend = 'gravityforms')
-    {
+    public function get($entry_id, $backend = 'gravityforms') {
         foreach ($this->all() as $entry) {
             if ($entry->ID == $entry_id) {
                 return $entry;
@@ -109,8 +106,7 @@ 
      *
      * @return int The total number of entries that are fetchable.
      */
-    public function total()
-    {
+    public function total() {
         $total = 0;
 
         /** Call all lazy callbacks. */
@@ -138,8 +134,7 @@ 
      *
      * @return \GV\Entry[] The entries as an array.
      */
-    public function all()
-    {
+    public function all() {
         if ($this->fetched >= 0 || parent::count()) {
             return parent::all();
         }
@@ -158,8 +153,7 @@ 
      *
      * @return array The plucked values.
      */
-    public function pluck($key)
-    {
+    public function pluck($key) {
         $result = [];
 
         foreach ($this->all() as $entry) {
@@ -179,8 +173,7 @@ 
      *
      * @return \GV\Entry|null The last entry or null.
      */
-    public function last()
-    {
+    public function last() {
         if ($this->fetched >= 0 || parent::count()) {
             return parent::last();
         }
@@ -197,8 +190,7 @@ 
      *
      * @return \GV\Entry|null The first entry or null.
      */
-    public function first()
-    {
+    public function first() {
         if ($this->fetched >= 0 || parent::count()) {
             return parent::first();
         }
@@ -215,8 +207,7 @@ 
      *
      * @return \GV\Entry_Collection This collection, now hydrated.
      */
-    public function fetch()
-    {
+    public function fetch() {
         if ($this->fetched >= 0) {
             return $this;
         }
@@ -255,8 +246,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the filter applied.
      */
-    public function filter(\GV\Entry_Filter $filter)
-    {
+    public function filter(\GV\Entry_Filter $filter) {
         $collection = clone $this;
         $collection->clear();
 
@@ -276,8 +266,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the sort applied.
      */
-    public function sort($sort)
-    {
+    public function sort($sort) {
         $collection = clone $this;
         $collection->clear();
 
@@ -297,8 +286,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the limit applied.
      */
-    public function limit($limit)
-    {
+    public function limit($limit) {
         $collection = clone $this;
         $collection->clear();
         $collection->limit = $limit;
@@ -321,8 +309,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
      */
-    public function offset($offset)
-    {
+    public function offset($offset) {
         $collection = clone $this;
         $collection->clear();
         $collection->offset = $offset;
@@ -337,8 +324,7 @@ 
      *
      * @return \GV\Entry_Collection A copy of the this collection with the offset applied.
      */
-    public function page($page)
-    {
+    public function page($page) {
         $collection = clone $this;
         $collection->clear();
         $collection->current_page = $page;
@@ -367,8 +353,7 @@ 
      *
      * @return void
      */
-    public function add_fetch_callback($callback)
-    {
+    public function add_fetch_callback($callback) {
         $this->add_callback('fetch', $callback);
     }
 
@@ -389,8 +374,7 @@ 
      *
      * @return void
      */
-    public function add_count_callback($callback)
-    {
+    public function add_count_callback($callback) {
         $this->add_callback('count', $callback);
     }
 
@@ -401,8 +385,7 @@ 
      *
      * @return void
      */
-    private function add_callback($type, $callback)
-    {
+    private function add_callback($type, $callback) {
         if (!is_callable($callback)) {
             return;
         }
@@ -413,8 +396,7 @@ 
     /**
      * @inheritdoc
      */
-    public function clear()
-    {
+    public function clear() {
         $this->fetched = -1;
         parent::clear();
     }

future/includes/class-gv-template-view-table.php

Indentation +556 added lines, -556 removed lines

@@ -4,7 +4,7 @@ 
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 /**
@@ -14,564 +14,564 @@ 
  */
 class View_Table_Template extends View_Template
 {
-    /**
-     * @var string The template slug to be loaded (like "table", "list")
-     */
-    public static $slug = 'table';
-
-    /**
-     * Constructor. Add filters to modify output.
-     *
-     * @since 2.0.4
-     *
-     * @param View             $view
-     * @param Entry_Collection $entries
-     * @param Request          $request
-     */
-    public function __construct(View $view, Entry_Collection $entries, Request $request)
-    {
-        add_filter('gravityview/template/field/label', [__CLASS__, 'add_columns_sort_links'], 100, 2);
-
-        parent::__construct($view, $entries, $request);
-    }
-
-    /**
-     * Add sorting links to HTML columns that support sorting.
-     *
-     * @since 2.0.4
-     * @since 2.0.5 Made static
-     *
-     * @static
-     *
-     * @param string               $column_label Label for the table column
-     * @param \GV\Template_Context $context
-     *
-     * @return string
-     */
-    public static function add_columns_sort_links($column_label, $context = null)
-    {
-        $sort_columns = $context->view->settings->get('sort_columns');
-
-        if (empty($sort_columns)) {
-            return $column_label;
-        }
-
-        if (!\GravityView_frontend::getInstance()->is_field_sortable($context->field->ID, $context->view->form->form)) {
-            return $column_label;
-        }
-
-        $sorting = [];
-
-        $directions = $context->view->settings->get('sort_direction');
-
-        $sorts = Utils::_GET('sort');
-
-        if ($sorts) {
-            if (is_array($sorts)) {
-                foreach ((array) $sorts as $key => $direction) {
-                    if ($key == $context->field->ID) {
-                        $sorting['key'] = $context->field->ID;
-                        $sorting['direction'] = strtolower($direction);
-                        break;
-                    }
-                }
-            } else {
-                if ($sorts == $context->field->ID) {
-                    $sorting['key'] = $context->field->ID;
-                    $sorting['direction'] = strtolower(Utils::_GET('dir', ''));
-                }
-            }
-        } else {
-            foreach ((array) $context->view->settings->get('sort_field', []) as $i => $sort_field) {
-                if ($sort_field == $context->field->ID) {
-                    $sorting['key'] = $sort_field;
-                    $sorting['direction'] = strtolower(Utils::get($directions, $i, ''));
-                    break; // Only get the first sort
-                }
-            }
-        }
-
-        $class = 'gv-sort';
-
-        $sort_field_id = \GravityView_frontend::_override_sorting_id_by_field_type($context->field->ID, $context->view->form->ID);
-
-        $sort_args = [
-            sprintf('sort[%s]', $context->field->ID),
-            'asc',
-        ];
-
-        // If we are already sorting by the current field...
-        if (!empty($sorting['key']) && (string) $sort_field_id === (string) $sorting['key']) {
-            switch ($sorting['direction']) {
-                // No sort
-                case '':
-                    $sort_args[1] = 'asc';
-                    $class .= ' gv-icon-caret-up-down';
-                    break;
-                case 'desc':
-                    $sort_args[1] = '';
-                    $class .= ' gv-icon-sort-asc';
-                    break;
-                case 'asc':
-                default:
-                    $sort_args[1] = 'desc';
-                    $class .= ' gv-icon-sort-desc';
-                    break;
-            }
-        } else {
-            $class .= ' gv-icon-caret-up-down';
-        }
-
-        $url = remove_query_arg(['pagenum']);
-        $url = remove_query_arg('sort', $url);
-        $multisort_url = self::_get_multisort_url($url, $sort_args, $context->field->ID);
-
-        $url = add_query_arg($sort_args[0], $sort_args[1], $url);
-
-        $return = '<a href="'.esc_url_raw($url).'"';
-
-        if (!empty($multisort_url)) {
-            $return .= ' data-multisort-href="'.esc_url_raw($multisort_url).'"';
-        }
-
-        $return .= ' class="'.$class.'" ></a>&nbsp;'.$column_label;
-
-        return $return;
-    }
-
-    /**
-     * Get the multi-sort URL used in the sorting links.
-     *
-     * @todo Consider moving to Utils?
-     *
-     * @since 2.3
-     * @see add_columns_sort_links
-     *
-     * @param string     $url       Single-sort URL
-     * @param array      $sort_args Single sorting for rules, in [ field_id, dir ] format
-     * @param string|int $field_id  ID of the current field being displayed
-     *
-     * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
-     */
-    public static function _get_multisort_url($url, $sort_args, $field_id)
-    {
-        $sorts = Utils::_GET('sort');
-
-        if (!is_array($sorts)) {
-            return $url;
-        }
-
-        $multisort_url = $url;
-
-        // If the field has already been sorted by, add the field to the URL
-        if (!in_array($field_id, $keys = array_keys($sorts))) {
-            if (count($keys)) {
-                $multisort_url = add_query_arg(sprintf('sort[%s]', end($keys)), $sorts[end($keys)], $multisort_url);
-                $multisort_url = add_query_arg($sort_args[0], $sort_args[1], $multisort_url);
-            } else {
-                $multisort_url = add_query_arg($sort_args[0], $sort_args[1], $multisort_url);
-            }
-        }
-        // Otherwise, we are just updating the sort order
-        else {
-
-            // Pass empty value to unset
-            if ('' === $sort_args[1]) {
-                unset($sorts[$field_id]);
-            } else {
-                $sorts[$field_id] = $sort_args[1];
-            }
-
-            $multisort_url = add_query_arg(['sort' => $sorts], $multisort_url);
-        }
-
-        return $multisort_url;
-    }
-
-    /**
-     * Output the table column names.
-     *
-     * @return void
-     */
-    public function the_columns()
-    {
-        $fields = $this->view->fields->by_position('directory_table-columns');
-
-        foreach ($fields->by_visible($this->view)->all() as $field) {
-            $context = Template_Context::from_template($this, compact('field'));
-
-            $args = [
-                'field'        => is_numeric($field->ID) ? $field->as_configuration() : null,
-                'hide_empty'   => false,
-                'zone_id'      => 'directory_table-columns',
-                'markup'       => '<th id="{{ field_id }}" class="{{ class }}" style="{{width:style}}" data-label="{{label_value:data-label}}">{{label}}</th>',
-                'label_markup' => '<span class="gv-field-label">{{ label }}</span>',
-                'label'        => self::get_field_column_label($field, $context),
-            ];
-
-            echo \gravityview_field_output($args, $context);
-        }
-    }
-
-    /**
-     * Returns the label for a column, with support for all deprecated filters.
-     *
-     * @since 2.1
-     *
-     * @param \GV\Field            $field
-     * @param \GV\Template_Context $context
-     */
-    protected static function get_field_column_label($field, $context = null)
-    {
-        $form = $field->form_id ? GF_Form::by_id($field->form_id) : $context->view->form;
-
-        /**
-         * @deprecated Here for back-compatibility.
-         */
-        $column_label = apply_filters('gravityview_render_after_label', $field->get_label($context->view, $form), $field->as_configuration());
-        $column_label = apply_filters('gravityview/template/field_label', $column_label, $field->as_configuration(), ($form && $form->form) ? $form->form : null, null);
-
-        /**
-         * @filter `gravityview/template/field/label` Override the field label.
-         *
-         * @since 2.0
-         *
-         * @param string               $column_label The label to override.
-         * @param \GV\Template_Context $context      The context. Does not have entry set here.
-         */
-        $column_label = apply_filters('gravityview/template/field/label', $column_label, $context);
-
-        return $column_label;
-    }
-
-    /**
-     * Output the entry row.
-     *
-     * @param \GV\Entry $entry      The entry to be rendered.
-     * @param array     $attributes The attributes for the <tr> tag
-     *
-     * @return void
-     */
-    public function the_entry(\GV\Entry $entry, $attributes)
-    {
-        $fields = $this->view->fields->by_position('directory_table-columns')->by_visible($this->view);
-
-        $context = Template_Context::from_template($this, compact('entry', 'fields'));
-
-        /**
-         * Push legacy entry context.
-         */
-        \GV\Mocks\Legacy_Context::load([
-            'entry' => $entry,
-        ]);
-
-        /**
-         * @filter `gravityview_table_cells` Modify the fields displayed in a table
-         *
-         * @param array             $fields
-         * @param \GravityView_View $this
-         *
-         * @deprecated Use `gravityview/template/table/fields`
-         */
-        $fields = apply_filters('gravityview_table_cells', $fields->as_configuration(), \GravityView_View::getInstance());
-        $fields = Field_Collection::from_configuration($fields);
-
-        /**
-         * @filter `gravityview/template/table/fields` Modify the fields displayed in this tables.
-         *
-         * @param \GV\Field_Collection $fields  The fields.
-         * @param \GV\Template_Context $context The context.
-         *
-         * @since 2.0
-         */
-        $fields = apply_filters('gravityview/template/table/fields', $fields, $context);
-
-        $context = Template_Context::from_template($this, compact('entry', 'fields'));
-
-        /**
-         * @filter `gravityview/template/table/entry/row/attributes` Filter the row attributes for the row in table view.
-         *
-         * @param array $attributes The HTML attributes.
-         * @param \GV\Template_Context The context.
-         *
-         * @since 2.0
-         */
-        $attributes = apply_filters('gravityview/template/table/entry/row/attributes', $attributes, $context);
-
-        /** Glue the attributes together. */
-        foreach ($attributes as $attribute => $value) {
-            $attributes[$attribute] = sprintf("$attribute=\"%s\"", esc_attr($value));
-        }
-        $attributes = implode(' ', $attributes); ?>
+	/**
+	 * @var string The template slug to be loaded (like "table", "list")
+	 */
+	public static $slug = 'table';
+
+	/**
+	 * Constructor. Add filters to modify output.
+	 *
+	 * @since 2.0.4
+	 *
+	 * @param View             $view
+	 * @param Entry_Collection $entries
+	 * @param Request          $request
+	 */
+	public function __construct(View $view, Entry_Collection $entries, Request $request)
+	{
+		add_filter('gravityview/template/field/label', [__CLASS__, 'add_columns_sort_links'], 100, 2);
+
+		parent::__construct($view, $entries, $request);
+	}
+
+	/**
+	 * Add sorting links to HTML columns that support sorting.
+	 *
+	 * @since 2.0.4
+	 * @since 2.0.5 Made static
+	 *
+	 * @static
+	 *
+	 * @param string               $column_label Label for the table column
+	 * @param \GV\Template_Context $context
+	 *
+	 * @return string
+	 */
+	public static function add_columns_sort_links($column_label, $context = null)
+	{
+		$sort_columns = $context->view->settings->get('sort_columns');
+
+		if (empty($sort_columns)) {
+			return $column_label;
+		}
+
+		if (!\GravityView_frontend::getInstance()->is_field_sortable($context->field->ID, $context->view->form->form)) {
+			return $column_label;
+		}
+
+		$sorting = [];
+
+		$directions = $context->view->settings->get('sort_direction');
+
+		$sorts = Utils::_GET('sort');
+
+		if ($sorts) {
+			if (is_array($sorts)) {
+				foreach ((array) $sorts as $key => $direction) {
+					if ($key == $context->field->ID) {
+						$sorting['key'] = $context->field->ID;
+						$sorting['direction'] = strtolower($direction);
+						break;
+					}
+				}
+			} else {
+				if ($sorts == $context->field->ID) {
+					$sorting['key'] = $context->field->ID;
+					$sorting['direction'] = strtolower(Utils::_GET('dir', ''));
+				}
+			}
+		} else {
+			foreach ((array) $context->view->settings->get('sort_field', []) as $i => $sort_field) {
+				if ($sort_field == $context->field->ID) {
+					$sorting['key'] = $sort_field;
+					$sorting['direction'] = strtolower(Utils::get($directions, $i, ''));
+					break; // Only get the first sort
+				}
+			}
+		}
+
+		$class = 'gv-sort';
+
+		$sort_field_id = \GravityView_frontend::_override_sorting_id_by_field_type($context->field->ID, $context->view->form->ID);
+
+		$sort_args = [
+			sprintf('sort[%s]', $context->field->ID),
+			'asc',
+		];
+
+		// If we are already sorting by the current field...
+		if (!empty($sorting['key']) && (string) $sort_field_id === (string) $sorting['key']) {
+			switch ($sorting['direction']) {
+				// No sort
+				case '':
+					$sort_args[1] = 'asc';
+					$class .= ' gv-icon-caret-up-down';
+					break;
+				case 'desc':
+					$sort_args[1] = '';
+					$class .= ' gv-icon-sort-asc';
+					break;
+				case 'asc':
+				default:
+					$sort_args[1] = 'desc';
+					$class .= ' gv-icon-sort-desc';
+					break;
+			}
+		} else {
+			$class .= ' gv-icon-caret-up-down';
+		}
+
+		$url = remove_query_arg(['pagenum']);
+		$url = remove_query_arg('sort', $url);
+		$multisort_url = self::_get_multisort_url($url, $sort_args, $context->field->ID);
+
+		$url = add_query_arg($sort_args[0], $sort_args[1], $url);
+
+		$return = '<a href="'.esc_url_raw($url).'"';
+
+		if (!empty($multisort_url)) {
+			$return .= ' data-multisort-href="'.esc_url_raw($multisort_url).'"';
+		}
+
+		$return .= ' class="'.$class.'" ></a>&nbsp;'.$column_label;
+
+		return $return;
+	}
+
+	/**
+	 * Get the multi-sort URL used in the sorting links.
+	 *
+	 * @todo Consider moving to Utils?
+	 *
+	 * @since 2.3
+	 * @see add_columns_sort_links
+	 *
+	 * @param string     $url       Single-sort URL
+	 * @param array      $sort_args Single sorting for rules, in [ field_id, dir ] format
+	 * @param string|int $field_id  ID of the current field being displayed
+	 *
+	 * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
+	 */
+	public static function _get_multisort_url($url, $sort_args, $field_id)
+	{
+		$sorts = Utils::_GET('sort');
+
+		if (!is_array($sorts)) {
+			return $url;
+		}
+
+		$multisort_url = $url;
+
+		// If the field has already been sorted by, add the field to the URL
+		if (!in_array($field_id, $keys = array_keys($sorts))) {
+			if (count($keys)) {
+				$multisort_url = add_query_arg(sprintf('sort[%s]', end($keys)), $sorts[end($keys)], $multisort_url);
+				$multisort_url = add_query_arg($sort_args[0], $sort_args[1], $multisort_url);
+			} else {
+				$multisort_url = add_query_arg($sort_args[0], $sort_args[1], $multisort_url);
+			}
+		}
+		// Otherwise, we are just updating the sort order
+		else {
+
+			// Pass empty value to unset
+			if ('' === $sort_args[1]) {
+				unset($sorts[$field_id]);
+			} else {
+				$sorts[$field_id] = $sort_args[1];
+			}
+
+			$multisort_url = add_query_arg(['sort' => $sorts], $multisort_url);
+		}
+
+		return $multisort_url;
+	}
+
+	/**
+	 * Output the table column names.
+	 *
+	 * @return void
+	 */
+	public function the_columns()
+	{
+		$fields = $this->view->fields->by_position('directory_table-columns');
+
+		foreach ($fields->by_visible($this->view)->all() as $field) {
+			$context = Template_Context::from_template($this, compact('field'));
+
+			$args = [
+				'field'        => is_numeric($field->ID) ? $field->as_configuration() : null,
+				'hide_empty'   => false,
+				'zone_id'      => 'directory_table-columns',
+				'markup'       => '<th id="{{ field_id }}" class="{{ class }}" style="{{width:style}}" data-label="{{label_value:data-label}}">{{label}}</th>',
+				'label_markup' => '<span class="gv-field-label">{{ label }}</span>',
+				'label'        => self::get_field_column_label($field, $context),
+			];
+
+			echo \gravityview_field_output($args, $context);
+		}
+	}
+
+	/**
+	 * Returns the label for a column, with support for all deprecated filters.
+	 *
+	 * @since 2.1
+	 *
+	 * @param \GV\Field            $field
+	 * @param \GV\Template_Context $context
+	 */
+	protected static function get_field_column_label($field, $context = null)
+	{
+		$form = $field->form_id ? GF_Form::by_id($field->form_id) : $context->view->form;
+
+		/**
+		 * @deprecated Here for back-compatibility.
+		 */
+		$column_label = apply_filters('gravityview_render_after_label', $field->get_label($context->view, $form), $field->as_configuration());
+		$column_label = apply_filters('gravityview/template/field_label', $column_label, $field->as_configuration(), ($form && $form->form) ? $form->form : null, null);
+
+		/**
+		 * @filter `gravityview/template/field/label` Override the field label.
+		 *
+		 * @since 2.0
+		 *
+		 * @param string               $column_label The label to override.
+		 * @param \GV\Template_Context $context      The context. Does not have entry set here.
+		 */
+		$column_label = apply_filters('gravityview/template/field/label', $column_label, $context);
+
+		return $column_label;
+	}
+
+	/**
+	 * Output the entry row.
+	 *
+	 * @param \GV\Entry $entry      The entry to be rendered.
+	 * @param array     $attributes The attributes for the <tr> tag
+	 *
+	 * @return void
+	 */
+	public function the_entry(\GV\Entry $entry, $attributes)
+	{
+		$fields = $this->view->fields->by_position('directory_table-columns')->by_visible($this->view);
+
+		$context = Template_Context::from_template($this, compact('entry', 'fields'));
+
+		/**
+		 * Push legacy entry context.
+		 */
+		\GV\Mocks\Legacy_Context::load([
+			'entry' => $entry,
+		]);
+
+		/**
+		 * @filter `gravityview_table_cells` Modify the fields displayed in a table
+		 *
+		 * @param array             $fields
+		 * @param \GravityView_View $this
+		 *
+		 * @deprecated Use `gravityview/template/table/fields`
+		 */
+		$fields = apply_filters('gravityview_table_cells', $fields->as_configuration(), \GravityView_View::getInstance());
+		$fields = Field_Collection::from_configuration($fields);
+
+		/**
+		 * @filter `gravityview/template/table/fields` Modify the fields displayed in this tables.
+		 *
+		 * @param \GV\Field_Collection $fields  The fields.
+		 * @param \GV\Template_Context $context The context.
+		 *
+		 * @since 2.0
+		 */
+		$fields = apply_filters('gravityview/template/table/fields', $fields, $context);
+
+		$context = Template_Context::from_template($this, compact('entry', 'fields'));
+
+		/**
+		 * @filter `gravityview/template/table/entry/row/attributes` Filter the row attributes for the row in table view.
+		 *
+		 * @param array $attributes The HTML attributes.
+		 * @param \GV\Template_Context The context.
+		 *
+		 * @since 2.0
+		 */
+		$attributes = apply_filters('gravityview/template/table/entry/row/attributes', $attributes, $context);
+
+		/** Glue the attributes together. */
+		foreach ($attributes as $attribute => $value) {
+			$attributes[$attribute] = sprintf("$attribute=\"%s\"", esc_attr($value));
+		}
+		$attributes = implode(' ', $attributes); ?>
 			<tr<?php echo $attributes ? " $attributes" : ''; ?>>
                 <?php
 
-                /**
-                 * @action `gravityview/template/table/cells/before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
-                 *
-                 * @since 2.0
-                 *
-                 * @param \GV\Template_Context The context.
-                 */
-                do_action('gravityview/template/table/cells/before', $context);
-
-        /**
-         * @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
-         *
-         * @since 1.0.7
-         *
-         * @param \GravityView_View $this Current GravityView_View object
-         *
-         * @deprecated Use `gravityview/template/table/cells/before`
-         */
-        do_action('gravityview_table_cells_before', \GravityView_View::getInstance());
-
-        foreach ($fields->all() as $field) {
-            if (isset($this->view->unions[$entry['form_id']])) {
-                if (isset($this->view->unions[$entry['form_id']][$field->ID])) {
-                    $field = $this->view->unions[$entry['form_id']][$field->ID];
-                } else {
-                    if (!$field instanceof Internal_Field) {
-                        $field = Internal_Field::from_configuration(['id' => 'custom']);
-                    }
-                }
-            }
-            $this->the_field($field, $entry);
-        }
-
-        /**
-         * @action `gravityview/template/table/cells/after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
-         *
-         * @since 2.0
-         *
-         * @param \GV\Template_Context The context.
-         */
-        do_action('gravityview/template/table/cells/after', $context);
-
-        /**
-         * @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
-         *
-         * @since 1.0.7
-         *
-         * @param \GravityView_View $this Current GravityView_View object
-         *
-         * @deprecated Use `gravityview/template/table/cells/after`
-         */
-        do_action('gravityview_table_cells_after', \GravityView_View::getInstance()); ?>
+				/**
+				 * @action `gravityview/template/table/cells/before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
+				 *
+				 * @since 2.0
+				 *
+				 * @param \GV\Template_Context The context.
+				 */
+				do_action('gravityview/template/table/cells/before', $context);
+
+		/**
+		 * @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
+		 *
+		 * @since 1.0.7
+		 *
+		 * @param \GravityView_View $this Current GravityView_View object
+		 *
+		 * @deprecated Use `gravityview/template/table/cells/before`
+		 */
+		do_action('gravityview_table_cells_before', \GravityView_View::getInstance());
+
+		foreach ($fields->all() as $field) {
+			if (isset($this->view->unions[$entry['form_id']])) {
+				if (isset($this->view->unions[$entry['form_id']][$field->ID])) {
+					$field = $this->view->unions[$entry['form_id']][$field->ID];
+				} else {
+					if (!$field instanceof Internal_Field) {
+						$field = Internal_Field::from_configuration(['id' => 'custom']);
+					}
+				}
+			}
+			$this->the_field($field, $entry);
+		}
+
+		/**
+		 * @action `gravityview/template/table/cells/after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
+		 *
+		 * @since 2.0
+		 *
+		 * @param \GV\Template_Context The context.
+		 */
+		do_action('gravityview/template/table/cells/after', $context);
+
+		/**
+		 * @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
+		 *
+		 * @since 1.0.7
+		 *
+		 * @param \GravityView_View $this Current GravityView_View object
+		 *
+		 * @deprecated Use `gravityview/template/table/cells/after`
+		 */
+		do_action('gravityview_table_cells_after', \GravityView_View::getInstance()); ?>
 			</tr>
 		<?php
-    }
-
-    /**
-     * Output a field cell.
-     *
-     * @param \GV\Field $field The field to be ouput.
-     * @param \GV\Field $entry The entry this field is for.
-     *
-     * @return void
-     */
-    public function the_field(\GV\Field $field, \GV\Entry $entry)
-    {
-        $form = $this->view->form;
-        $single_entry = $entry;
-
-        /**
-         * Push legacy entry context.
-         */
-        \GV\Mocks\Legacy_Context::load([
-            'field' => $field,
-        ]);
-
-        if ($entry->is_multi()) {
-            if (!$single_entry = $entry->from_field($field)) {
-                echo '<td></td>';
-
-                return;
-            }
-            $form = GF_Form::by_id($field->form_id);
-        }
-
-        $renderer = new Field_Renderer();
-        $source = is_numeric($field->ID) ? $form : new Internal_Source();
-
-        $value = $renderer->render($field, $this->view, $source, $entry, $this->request);
-
-        $context = Template_Context::from_template($this, compact('field'));
-        $context->entry = $single_entry;
-
-        $args = [
-            'entry'      => $entry->as_entry(),
-            'field'      => is_numeric($field->ID) ? $field->as_configuration() : null,
-            'value'      => $value,
-            'hide_empty' => false,
-            'zone_id'    => 'directory_table-columns',
-            'label'      => self::get_field_column_label($field, $context),
-            'markup'     => '<td id="{{ field_id }}" class="{{ class }}" data-label="{{label_value:data-label}}">{{ value }}</td>',
-            'form'       => $form,
-        ];
-
-        /** Output. */
-        echo \gravityview_field_output($args, $context);
-    }
-
-    /**
-     * `gravityview_table_body_before` and `gravityview/template/table/body/before` actions.
-     *
-     * Output inside the `tbody` of the table.
-     *
-     * @param $context \GV\Template_Context The 2.0 context.
-     *
-     * @return void
-     */
-    public static function body_before($context)
-    {
-        /**
-         * @action `gravityview/template/table/body/before` Output inside the `tbody` of the table.
-         *
-         * @since 2.0
-         *
-         * @param \GV\Template_Context $context The template context.
-         */
-        do_action('gravityview/template/table/body/before', $context);
-
-        /**
-         * @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
-         *
-         * @deprecated Use `gravityview/template/table/body/before`
-         * @since 1.0.7
-         *
-         * @param \GravityView_View $gravityview_view Current GravityView_View object.
-         */
-        do_action('gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */);
-    }
-
-    /**
-     * `gravityview_table_body_after` and `gravityview/template/table/body/after` actions.
-     *
-     * Output inside the `tbody` of the table.
-     *
-     * @param $context \GV\Template_Context The 2.0 context.
-     *
-     * @return void
-     */
-    public static function body_after($context)
-    {
-        /**
-         * @action `gravityview/template/table/body/after` Output inside the `tbody` of the table at the end.
-         *
-         * @since 2.0
-         *
-         * @param \GV\Template_Context $context The template context.
-         */
-        do_action('gravityview/template/table/body/after', $context);
-
-        /**
-         * @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
-         *
-         * @deprecated Use `gravityview/template/table/body/after`
-         * @since 1.0.7
-         *
-         * @param \GravityView_View $gravityview_view Current GravityView_View object.
-         */
-        do_action('gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */);
-    }
-
-    /**
-     * `gravityview_table_tr_before` and `gravityview/template/table/tr/after` actions.
-     *
-     * Output inside the `tr` of the table.
-     *
-     * @param $context \GV\Template_Context The 2.0 context.
-     *
-     * @return void
-     */
-    public static function tr_before($context)
-    {
-        /**
-         * @action `gravityview/template/table/tr/before` Output inside the `tr` of the table when there are no results.
-         *
-         * @since 2.0
-         *
-         * @param \GV\Template_Context $context The template context.
-         */
-        do_action('gravityview/template/table/tr/before', $context);
-
-        /**
-         * @action `gravityview_table_tr_before` Before the `tr` while rendering each entry in the loop. Can be used to insert additional table rows.
-         *
-         * @since 1.0.7
-         * @deprecated USe `gravityview/template/table/tr/before`
-         *
-         * @param \GravityView_View $gravityview_view Current GraivtyView_View object.
-         */
-        do_action('gravityview_table_tr_before', \GravityView_View::getInstance() /** ugh! */);
-    }
-
-    /**
-     * `gravityview_table_tr_after` and `gravityview/template/table/tr/after` actions.
-     *
-     * Output inside the `tr` of the table.
-     *
-     * @param $context \GV\Template_Context The 2.0 context.
-     *
-     * @return void
-     */
-    public static function tr_after($context)
-    {
-        /**
-         * @action `gravityview/template/table/tr/after` Output inside the `tr` of the table when there are no results.
-         *
-         * @since 2.0
-         *
-         * @param \GV\Template_Context $context The template context.
-         */
-        do_action('gravityview/template/table/tr/after', $context);
-
-        /**
-         * @action `gravityview_table_tr_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
-         *
-         * @since 1.0.7
-         * @deprecated USe `gravityview/template/table/tr/after`
-         *
-         * @param \GravityView_View $gravityview_view Current GravityView_View object.
-         */
-        do_action('gravityview_table_tr_after', \GravityView_View::getInstance() /** ugh! */);
-    }
-
-    /**
-     * `gravityview_entry_class` and `gravityview/template/table/entry/class` filters.
-     *
-     * Modify of the class of a row.
-     *
-     * @param string    $class The class.
-     * @param \GV\Entry $entry The entry.
-     * @param \GV\Template_Context The context.
-     *
-     * @return string The classes.
-     */
-    public static function entry_class($class, $entry, $context)
-    {
-        /**
-         * @filter `gravityview_entry_class` Modify the class applied to the entry row.
-         *
-         * @param string            $class Existing class.
-         * @param array             $entry Current entry being displayed
-         * @param \GravityView_View $this  Current GravityView_View object
-         *
-         * @deprecated Use `gravityview/template/table/entry/class`
-         *
-         * @return string The modified class.
-         */
-        $class = apply_filters('gravityview_entry_class', $class, $entry->as_entry(), \GravityView_View::getInstance());
-
-        /**
-         * @filter `gravityview/template/table/entry/class` Modify the class aplied to the entry row.
-         *
-         * @param string $class The existing class.
-         * @param \GV\Template_Context The context.
-         *
-         * @return string The modified class.
-         */
-        return apply_filters('gravityview/template/table/entry/class', $class, Template_Context::from_template($context->template, compact('entry')));
-    }
+	}
+
+	/**
+	 * Output a field cell.
+	 *
+	 * @param \GV\Field $field The field to be ouput.
+	 * @param \GV\Field $entry The entry this field is for.
+	 *
+	 * @return void
+	 */
+	public function the_field(\GV\Field $field, \GV\Entry $entry)
+	{
+		$form = $this->view->form;
+		$single_entry = $entry;
+
+		/**
+		 * Push legacy entry context.
+		 */
+		\GV\Mocks\Legacy_Context::load([
+			'field' => $field,
+		]);
+
+		if ($entry->is_multi()) {
+			if (!$single_entry = $entry->from_field($field)) {
+				echo '<td></td>';
+
+				return;
+			}
+			$form = GF_Form::by_id($field->form_id);
+		}
+
+		$renderer = new Field_Renderer();
+		$source = is_numeric($field->ID) ? $form : new Internal_Source();
+
+		$value = $renderer->render($field, $this->view, $source, $entry, $this->request);
+
+		$context = Template_Context::from_template($this, compact('field'));
+		$context->entry = $single_entry;
+
+		$args = [
+			'entry'      => $entry->as_entry(),
+			'field'      => is_numeric($field->ID) ? $field->as_configuration() : null,
+			'value'      => $value,
+			'hide_empty' => false,
+			'zone_id'    => 'directory_table-columns',
+			'label'      => self::get_field_column_label($field, $context),
+			'markup'     => '<td id="{{ field_id }}" class="{{ class }}" data-label="{{label_value:data-label}}">{{ value }}</td>',
+			'form'       => $form,
+		];
+
+		/** Output. */
+		echo \gravityview_field_output($args, $context);
+	}
+
+	/**
+	 * `gravityview_table_body_before` and `gravityview/template/table/body/before` actions.
+	 *
+	 * Output inside the `tbody` of the table.
+	 *
+	 * @param $context \GV\Template_Context The 2.0 context.
+	 *
+	 * @return void
+	 */
+	public static function body_before($context)
+	{
+		/**
+		 * @action `gravityview/template/table/body/before` Output inside the `tbody` of the table.
+		 *
+		 * @since 2.0
+		 *
+		 * @param \GV\Template_Context $context The template context.
+		 */
+		do_action('gravityview/template/table/body/before', $context);
+
+		/**
+		 * @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
+		 *
+		 * @deprecated Use `gravityview/template/table/body/before`
+		 * @since 1.0.7
+		 *
+		 * @param \GravityView_View $gravityview_view Current GravityView_View object.
+		 */
+		do_action('gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */);
+	}
+
+	/**
+	 * `gravityview_table_body_after` and `gravityview/template/table/body/after` actions.
+	 *
+	 * Output inside the `tbody` of the table.
+	 *
+	 * @param $context \GV\Template_Context The 2.0 context.
+	 *
+	 * @return void
+	 */
+	public static function body_after($context)
+	{
+		/**
+		 * @action `gravityview/template/table/body/after` Output inside the `tbody` of the table at the end.
+		 *
+		 * @since 2.0
+		 *
+		 * @param \GV\Template_Context $context The template context.
+		 */
+		do_action('gravityview/template/table/body/after', $context);
+
+		/**
+		 * @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
+		 *
+		 * @deprecated Use `gravityview/template/table/body/after`
+		 * @since 1.0.7
+		 *
+		 * @param \GravityView_View $gravityview_view Current GravityView_View object.
+		 */
+		do_action('gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */);
+	}
+
+	/**
+	 * `gravityview_table_tr_before` and `gravityview/template/table/tr/after` actions.
+	 *
+	 * Output inside the `tr` of the table.
+	 *
+	 * @param $context \GV\Template_Context The 2.0 context.
+	 *
+	 * @return void
+	 */
+	public static function tr_before($context)
+	{
+		/**
+		 * @action `gravityview/template/table/tr/before` Output inside the `tr` of the table when there are no results.
+		 *
+		 * @since 2.0
+		 *
+		 * @param \GV\Template_Context $context The template context.
+		 */
+		do_action('gravityview/template/table/tr/before', $context);
+
+		/**
+		 * @action `gravityview_table_tr_before` Before the `tr` while rendering each entry in the loop. Can be used to insert additional table rows.
+		 *
+		 * @since 1.0.7
+		 * @deprecated USe `gravityview/template/table/tr/before`
+		 *
+		 * @param \GravityView_View $gravityview_view Current GraivtyView_View object.
+		 */
+		do_action('gravityview_table_tr_before', \GravityView_View::getInstance() /** ugh! */);
+	}
+
+	/**
+	 * `gravityview_table_tr_after` and `gravityview/template/table/tr/after` actions.
+	 *
+	 * Output inside the `tr` of the table.
+	 *
+	 * @param $context \GV\Template_Context The 2.0 context.
+	 *
+	 * @return void
+	 */
+	public static function tr_after($context)
+	{
+		/**
+		 * @action `gravityview/template/table/tr/after` Output inside the `tr` of the table when there are no results.
+		 *
+		 * @since 2.0
+		 *
+		 * @param \GV\Template_Context $context The template context.
+		 */
+		do_action('gravityview/template/table/tr/after', $context);
+
+		/**
+		 * @action `gravityview_table_tr_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
+		 *
+		 * @since 1.0.7
+		 * @deprecated USe `gravityview/template/table/tr/after`
+		 *
+		 * @param \GravityView_View $gravityview_view Current GravityView_View object.
+		 */
+		do_action('gravityview_table_tr_after', \GravityView_View::getInstance() /** ugh! */);
+	}
+
+	/**
+	 * `gravityview_entry_class` and `gravityview/template/table/entry/class` filters.
+	 *
+	 * Modify of the class of a row.
+	 *
+	 * @param string    $class The class.
+	 * @param \GV\Entry $entry The entry.
+	 * @param \GV\Template_Context The context.
+	 *
+	 * @return string The classes.
+	 */
+	public static function entry_class($class, $entry, $context)
+	{
+		/**
+		 * @filter `gravityview_entry_class` Modify the class applied to the entry row.
+		 *
+		 * @param string            $class Existing class.
+		 * @param array             $entry Current entry being displayed
+		 * @param \GravityView_View $this  Current GravityView_View object
+		 *
+		 * @deprecated Use `gravityview/template/table/entry/class`
+		 *
+		 * @return string The modified class.
+		 */
+		$class = apply_filters('gravityview_entry_class', $class, $entry->as_entry(), \GravityView_View::getInstance());
+
+		/**
+		 * @filter `gravityview/template/table/entry/class` Modify the class aplied to the entry row.
+		 *
+		 * @param string $class The existing class.
+		 * @param \GV\Template_Context The context.
+		 *
+		 * @return string The modified class.
+		 */
+		return apply_filters('gravityview/template/table/entry/class', $class, Template_Context::from_template($context->template, compact('entry')));
+	}
 }

Spacing +113 added lines, -113 removed lines

@@ -3,7 +3,7 @@ 
 namespace GV;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -28,11 +28,11 @@ 
      * @param Entry_Collection $entries
      * @param Request          $request
      */
-    public function __construct(View $view, Entry_Collection $entries, Request $request)
+    public function __construct( View $view, Entry_Collection $entries, Request $request )
     {
-        add_filter('gravityview/template/field/label', [__CLASS__, 'add_columns_sort_links'], 100, 2);
+        add_filter( 'gravityview/template/field/label', [ __CLASS__, 'add_columns_sort_links' ], 100, 2 );
 
-        parent::__construct($view, $entries, $request);
+        parent::__construct( $view, $entries, $request );
     }
 
     /**
@@ -48,44 +48,44 @@ 
      *
      * @return string
      */
-    public static function add_columns_sort_links($column_label, $context = null)
+    public static function add_columns_sort_links( $column_label, $context = null )
     {
-        $sort_columns = $context->view->settings->get('sort_columns');
+        $sort_columns = $context->view->settings->get( 'sort_columns' );
 
-        if (empty($sort_columns)) {
+        if ( empty( $sort_columns ) ) {
             return $column_label;
         }
 
-        if (!\GravityView_frontend::getInstance()->is_field_sortable($context->field->ID, $context->view->form->form)) {
+        if ( ! \GravityView_frontend::getInstance()->is_field_sortable( $context->field->ID, $context->view->form->form ) ) {
             return $column_label;
         }
 
-        $sorting = [];
+        $sorting = [ ];
 
-        $directions = $context->view->settings->get('sort_direction');
+        $directions = $context->view->settings->get( 'sort_direction' );
 
-        $sorts = Utils::_GET('sort');
+        $sorts = Utils::_GET( 'sort' );
 
-        if ($sorts) {
-            if (is_array($sorts)) {
-                foreach ((array) $sorts as $key => $direction) {
-                    if ($key == $context->field->ID) {
-                        $sorting['key'] = $context->field->ID;
-                        $sorting['direction'] = strtolower($direction);
+        if ( $sorts ) {
+            if ( is_array( $sorts ) ) {
+                foreach ( (array)$sorts as $key => $direction ) {
+                    if ( $key == $context->field->ID ) {
+                        $sorting[ 'key' ] = $context->field->ID;
+                        $sorting[ 'direction' ] = strtolower( $direction );
                         break;
                     }
                 }
             } else {
-                if ($sorts == $context->field->ID) {
-                    $sorting['key'] = $context->field->ID;
-                    $sorting['direction'] = strtolower(Utils::_GET('dir', ''));
+                if ( $sorts == $context->field->ID ) {
+                    $sorting[ 'key' ] = $context->field->ID;
+                    $sorting[ 'direction' ] = strtolower( Utils::_GET( 'dir', '' ) );
                 }
             }
         } else {
-            foreach ((array) $context->view->settings->get('sort_field', []) as $i => $sort_field) {
-                if ($sort_field == $context->field->ID) {
-                    $sorting['key'] = $sort_field;
-                    $sorting['direction'] = strtolower(Utils::get($directions, $i, ''));
+            foreach ( (array)$context->view->settings->get( 'sort_field', [ ] ) as $i => $sort_field ) {
+                if ( $sort_field == $context->field->ID ) {
+                    $sorting[ 'key' ] = $sort_field;
+                    $sorting[ 'direction' ] = strtolower( Utils::get( $directions, $i, '' ) );
                     break; // Only get the first sort
                 }
             }
@@ -93,28 +93,28 @@ 
 
         $class = 'gv-sort';
 
-        $sort_field_id = \GravityView_frontend::_override_sorting_id_by_field_type($context->field->ID, $context->view->form->ID);
+        $sort_field_id = \GravityView_frontend::_override_sorting_id_by_field_type( $context->field->ID, $context->view->form->ID );
 
         $sort_args = [
-            sprintf('sort[%s]', $context->field->ID),
+            sprintf( 'sort[%s]', $context->field->ID ),
             'asc',
         ];
 
         // If we are already sorting by the current field...
-        if (!empty($sorting['key']) && (string) $sort_field_id === (string) $sorting['key']) {
-            switch ($sorting['direction']) {
+        if ( ! empty( $sorting[ 'key' ] ) && (string)$sort_field_id === (string)$sorting[ 'key' ] ) {
+            switch ( $sorting[ 'direction' ] ) {
                 // No sort
                 case '':
-                    $sort_args[1] = 'asc';
+                    $sort_args[ 1 ] = 'asc';
                     $class .= ' gv-icon-caret-up-down';
                     break;
                 case 'desc':
-                    $sort_args[1] = '';
+                    $sort_args[ 1 ] = '';
                     $class .= ' gv-icon-sort-asc';
                     break;
                 case 'asc':
                 default:
-                    $sort_args[1] = 'desc';
+                    $sort_args[ 1 ] = 'desc';
                     $class .= ' gv-icon-sort-desc';
                     break;
             }
@@ -122,19 +122,19 @@ 
             $class .= ' gv-icon-caret-up-down';
         }
 
-        $url = remove_query_arg(['pagenum']);
-        $url = remove_query_arg('sort', $url);
-        $multisort_url = self::_get_multisort_url($url, $sort_args, $context->field->ID);
+        $url = remove_query_arg( [ 'pagenum' ] );
+        $url = remove_query_arg( 'sort', $url );
+        $multisort_url = self::_get_multisort_url( $url, $sort_args, $context->field->ID );
 
-        $url = add_query_arg($sort_args[0], $sort_args[1], $url);
+        $url = add_query_arg( $sort_args[ 0 ], $sort_args[ 1 ], $url );
 
-        $return = '<a href="'.esc_url_raw($url).'"';
+        $return = '<a href="' . esc_url_raw( $url ) . '"';
 
-        if (!empty($multisort_url)) {
-            $return .= ' data-multisort-href="'.esc_url_raw($multisort_url).'"';
+        if ( ! empty( $multisort_url ) ) {
+            $return .= ' data-multisort-href="' . esc_url_raw( $multisort_url ) . '"';
         }
 
-        $return .= ' class="'.$class.'" ></a>&nbsp;'.$column_label;
+        $return .= ' class="' . $class . '" ></a>&nbsp;' . $column_label;
 
         return $return;
     }
@@ -153,36 +153,36 @@ 
      *
      * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
      */
-    public static function _get_multisort_url($url, $sort_args, $field_id)
+    public static function _get_multisort_url( $url, $sort_args, $field_id )
     {
-        $sorts = Utils::_GET('sort');
+        $sorts = Utils::_GET( 'sort' );
 
-        if (!is_array($sorts)) {
+        if ( ! is_array( $sorts ) ) {
             return $url;
         }
 
         $multisort_url = $url;
 
         // If the field has already been sorted by, add the field to the URL
-        if (!in_array($field_id, $keys = array_keys($sorts))) {
-            if (count($keys)) {
-                $multisort_url = add_query_arg(sprintf('sort[%s]', end($keys)), $sorts[end($keys)], $multisort_url);
-                $multisort_url = add_query_arg($sort_args[0], $sort_args[1], $multisort_url);
+        if ( ! in_array( $field_id, $keys = array_keys( $sorts ) ) ) {
+            if ( count( $keys ) ) {
+                $multisort_url = add_query_arg( sprintf( 'sort[%s]', end( $keys ) ), $sorts[ end( $keys ) ], $multisort_url );
+                $multisort_url = add_query_arg( $sort_args[ 0 ], $sort_args[ 1 ], $multisort_url );
             } else {
-                $multisort_url = add_query_arg($sort_args[0], $sort_args[1], $multisort_url);
+                $multisort_url = add_query_arg( $sort_args[ 0 ], $sort_args[ 1 ], $multisort_url );
             }
         }
         // Otherwise, we are just updating the sort order
         else {
 
             // Pass empty value to unset
-            if ('' === $sort_args[1]) {
-                unset($sorts[$field_id]);
+            if ( '' === $sort_args[ 1 ] ) {
+                unset( $sorts[ $field_id ] );
             } else {
-                $sorts[$field_id] = $sort_args[1];
+                $sorts[ $field_id ] = $sort_args[ 1 ];
             }
 
-            $multisort_url = add_query_arg(['sort' => $sorts], $multisort_url);
+            $multisort_url = add_query_arg( [ 'sort' => $sorts ], $multisort_url );
         }
 
         return $multisort_url;
@@ -195,21 +195,21 @@ 
      */
     public function the_columns()
     {
-        $fields = $this->view->fields->by_position('directory_table-columns');
+        $fields = $this->view->fields->by_position( 'directory_table-columns' );
 
-        foreach ($fields->by_visible($this->view)->all() as $field) {
-            $context = Template_Context::from_template($this, compact('field'));
+        foreach ( $fields->by_visible( $this->view )->all() as $field ) {
+            $context = Template_Context::from_template( $this, compact( 'field' ) );
 
             $args = [
-                'field'        => is_numeric($field->ID) ? $field->as_configuration() : null,
+                'field'        => is_numeric( $field->ID ) ? $field->as_configuration() : null,
                 'hide_empty'   => false,
                 'zone_id'      => 'directory_table-columns',
                 'markup'       => '<th id="{{ field_id }}" class="{{ class }}" style="{{width:style}}" data-label="{{label_value:data-label}}">{{label}}</th>',
                 'label_markup' => '<span class="gv-field-label">{{ label }}</span>',
-                'label'        => self::get_field_column_label($field, $context),
+                'label'        => self::get_field_column_label( $field, $context ),
             ];
 
-            echo \gravityview_field_output($args, $context);
+            echo \gravityview_field_output( $args, $context );
         }
     }
 
@@ -221,15 +221,15 @@ 
      * @param \GV\Field            $field
      * @param \GV\Template_Context $context
      */
-    protected static function get_field_column_label($field, $context = null)
+    protected static function get_field_column_label( $field, $context = null )
     {
-        $form = $field->form_id ? GF_Form::by_id($field->form_id) : $context->view->form;
+        $form = $field->form_id ? GF_Form::by_id( $field->form_id ) : $context->view->form;
 
         /**
          * @deprecated Here for back-compatibility.
          */
-        $column_label = apply_filters('gravityview_render_after_label', $field->get_label($context->view, $form), $field->as_configuration());
-        $column_label = apply_filters('gravityview/template/field_label', $column_label, $field->as_configuration(), ($form && $form->form) ? $form->form : null, null);
+        $column_label = apply_filters( 'gravityview_render_after_label', $field->get_label( $context->view, $form ), $field->as_configuration() );
+        $column_label = apply_filters( 'gravityview/template/field_label', $column_label, $field->as_configuration(), ( $form && $form->form ) ? $form->form : null, null );
 
         /**
          * @filter `gravityview/template/field/label` Override the field label.
@@ -239,7 +239,7 @@ 
          * @param string               $column_label The label to override.
          * @param \GV\Template_Context $context      The context. Does not have entry set here.
          */
-        $column_label = apply_filters('gravityview/template/field/label', $column_label, $context);
+        $column_label = apply_filters( 'gravityview/template/field/label', $column_label, $context );
 
         return $column_label;
     }
@@ -252,18 +252,18 @@ 
      *
      * @return void
      */
-    public function the_entry(\GV\Entry $entry, $attributes)
+    public function the_entry( \GV\Entry $entry, $attributes )
     {
-        $fields = $this->view->fields->by_position('directory_table-columns')->by_visible($this->view);
+        $fields = $this->view->fields->by_position( 'directory_table-columns' )->by_visible( $this->view );
 
-        $context = Template_Context::from_template($this, compact('entry', 'fields'));
+        $context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );
 
         /**
          * Push legacy entry context.
          */
-        \GV\Mocks\Legacy_Context::load([
+        \GV\Mocks\Legacy_Context::load( [
             'entry' => $entry,
-        ]);
+        ] );
 
         /**
          * @filter `gravityview_table_cells` Modify the fields displayed in a table
@@ -273,8 +273,8 @@ 
          *
          * @deprecated Use `gravityview/template/table/fields`
          */
-        $fields = apply_filters('gravityview_table_cells', $fields->as_configuration(), \GravityView_View::getInstance());
-        $fields = Field_Collection::from_configuration($fields);
+        $fields = apply_filters( 'gravityview_table_cells', $fields->as_configuration(), \GravityView_View::getInstance() );
+        $fields = Field_Collection::from_configuration( $fields );
 
         /**
          * @filter `gravityview/template/table/fields` Modify the fields displayed in this tables.
@@ -284,9 +284,9 @@ 
          *
          * @since 2.0
          */
-        $fields = apply_filters('gravityview/template/table/fields', $fields, $context);
+        $fields = apply_filters( 'gravityview/template/table/fields', $fields, $context );
 
-        $context = Template_Context::from_template($this, compact('entry', 'fields'));
+        $context = Template_Context::from_template( $this, compact( 'entry', 'fields' ) );
 
         /**
          * @filter `gravityview/template/table/entry/row/attributes` Filter the row attributes for the row in table view.
@@ -296,13 +296,13 @@ 
          *
          * @since 2.0
          */
-        $attributes = apply_filters('gravityview/template/table/entry/row/attributes', $attributes, $context);
+        $attributes = apply_filters( 'gravityview/template/table/entry/row/attributes', $attributes, $context );
 
         /** Glue the attributes together. */
-        foreach ($attributes as $attribute => $value) {
-            $attributes[$attribute] = sprintf("$attribute=\"%s\"", esc_attr($value));
+        foreach ( $attributes as $attribute => $value ) {
+            $attributes[ $attribute ] = sprintf( "$attribute=\"%s\"", esc_attr( $value ) );
         }
-        $attributes = implode(' ', $attributes); ?>
+        $attributes = implode( ' ', $attributes ); ?>
 			<tr<?php echo $attributes ? " $attributes" : ''; ?>>
                 <?php
 
@@ -313,7 +313,7 @@ 
                  *
                  * @param \GV\Template_Context The context.
                  */
-                do_action('gravityview/template/table/cells/before', $context);
+                do_action( 'gravityview/template/table/cells/before', $context );
 
         /**
          * @action `gravityview_table_cells_before` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
@@ -324,19 +324,19 @@ 
          *
          * @deprecated Use `gravityview/template/table/cells/before`
          */
-        do_action('gravityview_table_cells_before', \GravityView_View::getInstance());
+        do_action( 'gravityview_table_cells_before', \GravityView_View::getInstance() );
 
-        foreach ($fields->all() as $field) {
-            if (isset($this->view->unions[$entry['form_id']])) {
-                if (isset($this->view->unions[$entry['form_id']][$field->ID])) {
-                    $field = $this->view->unions[$entry['form_id']][$field->ID];
+        foreach ( $fields->all() as $field ) {
+            if ( isset( $this->view->unions[ $entry[ 'form_id' ] ] ) ) {
+                if ( isset( $this->view->unions[ $entry[ 'form_id' ] ][ $field->ID ] ) ) {
+                    $field = $this->view->unions[ $entry[ 'form_id' ] ][ $field->ID ];
                 } else {
-                    if (!$field instanceof Internal_Field) {
-                        $field = Internal_Field::from_configuration(['id' => 'custom']);
+                    if ( ! $field instanceof Internal_Field ) {
+                        $field = Internal_Field::from_configuration( [ 'id' => 'custom' ] );
                     }
                 }
             }
-            $this->the_field($field, $entry);
+            $this->the_field( $field, $entry );
         }
 
         /**
@@ -346,7 +346,7 @@ 
          *
          * @param \GV\Template_Context The context.
          */
-        do_action('gravityview/template/table/cells/after', $context);
+        do_action( 'gravityview/template/table/cells/after', $context );
 
         /**
          * @action `gravityview_table_cells_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
@@ -357,7 +357,7 @@ 
          *
          * @deprecated Use `gravityview/template/table/cells/after`
          */
-        do_action('gravityview_table_cells_after', \GravityView_View::getInstance()); ?>
+        do_action( 'gravityview_table_cells_after', \GravityView_View::getInstance() ); ?>
 			</tr>
 		<?php
     }
@@ -370,7 +370,7 @@ 
      *
      * @return void
      */
-    public function the_field(\GV\Field $field, \GV\Entry $entry)
+    public function the_field( \GV\Field $field, \GV\Entry $entry )
     {
         $form = $this->view->form;
         $single_entry = $entry;
@@ -378,40 +378,40 @@ 
         /**
          * Push legacy entry context.
          */
-        \GV\Mocks\Legacy_Context::load([
+        \GV\Mocks\Legacy_Context::load( [
             'field' => $field,
-        ]);
+        ] );
 
-        if ($entry->is_multi()) {
-            if (!$single_entry = $entry->from_field($field)) {
+        if ( $entry->is_multi() ) {
+            if ( ! $single_entry = $entry->from_field( $field ) ) {
                 echo '<td></td>';
 
                 return;
             }
-            $form = GF_Form::by_id($field->form_id);
+            $form = GF_Form::by_id( $field->form_id );
         }
 
         $renderer = new Field_Renderer();
-        $source = is_numeric($field->ID) ? $form : new Internal_Source();
+        $source = is_numeric( $field->ID ) ? $form : new Internal_Source();
 
-        $value = $renderer->render($field, $this->view, $source, $entry, $this->request);
+        $value = $renderer->render( $field, $this->view, $source, $entry, $this->request );
 
-        $context = Template_Context::from_template($this, compact('field'));
+        $context = Template_Context::from_template( $this, compact( 'field' ) );
         $context->entry = $single_entry;
 
         $args = [
             'entry'      => $entry->as_entry(),
-            'field'      => is_numeric($field->ID) ? $field->as_configuration() : null,
+            'field'      => is_numeric( $field->ID ) ? $field->as_configuration() : null,
             'value'      => $value,
             'hide_empty' => false,
             'zone_id'    => 'directory_table-columns',
-            'label'      => self::get_field_column_label($field, $context),
+            'label'      => self::get_field_column_label( $field, $context ),
             'markup'     => '<td id="{{ field_id }}" class="{{ class }}" data-label="{{label_value:data-label}}">{{ value }}</td>',
             'form'       => $form,
         ];
 
         /** Output. */
-        echo \gravityview_field_output($args, $context);
+        echo \gravityview_field_output( $args, $context );
     }
 
     /**
@@ -423,7 +423,7 @@ 
      *
      * @return void
      */
-    public static function body_before($context)
+    public static function body_before( $context )
     {
         /**
          * @action `gravityview/template/table/body/before` Output inside the `tbody` of the table.
@@ -432,7 +432,7 @@ 
          *
          * @param \GV\Template_Context $context The template context.
          */
-        do_action('gravityview/template/table/body/before', $context);
+        do_action( 'gravityview/template/table/body/before', $context );
 
         /**
          * @action `gravityview_table_body_before` Inside the `tbody`, before any rows are rendered. Can be used to insert additional rows.
@@ -442,7 +442,7 @@ 
          *
          * @param \GravityView_View $gravityview_view Current GravityView_View object.
          */
-        do_action('gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */);
+        do_action( 'gravityview_table_body_before', \GravityView_View::getInstance() /** ugh! */ );
     }
 
     /**
@@ -454,7 +454,7 @@ 
      *
      * @return void
      */
-    public static function body_after($context)
+    public static function body_after( $context )
     {
         /**
          * @action `gravityview/template/table/body/after` Output inside the `tbody` of the table at the end.
@@ -463,7 +463,7 @@ 
          *
          * @param \GV\Template_Context $context The template context.
          */
-        do_action('gravityview/template/table/body/after', $context);
+        do_action( 'gravityview/template/table/body/after', $context );
 
         /**
          * @action `gravityview_table_body_after` Inside the `tbody`, after any rows are rendered. Can be used to insert additional rows.
@@ -473,7 +473,7 @@ 
          *
          * @param \GravityView_View $gravityview_view Current GravityView_View object.
          */
-        do_action('gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */);
+        do_action( 'gravityview_table_body_after', \GravityView_View::getInstance() /** ugh! */ );
     }
 
     /**
@@ -485,7 +485,7 @@ 
      *
      * @return void
      */
-    public static function tr_before($context)
+    public static function tr_before( $context )
     {
         /**
          * @action `gravityview/template/table/tr/before` Output inside the `tr` of the table when there are no results.
@@ -494,7 +494,7 @@ 
          *
          * @param \GV\Template_Context $context The template context.
          */
-        do_action('gravityview/template/table/tr/before', $context);
+        do_action( 'gravityview/template/table/tr/before', $context );
 
         /**
          * @action `gravityview_table_tr_before` Before the `tr` while rendering each entry in the loop. Can be used to insert additional table rows.
@@ -504,7 +504,7 @@ 
          *
          * @param \GravityView_View $gravityview_view Current GraivtyView_View object.
          */
-        do_action('gravityview_table_tr_before', \GravityView_View::getInstance() /** ugh! */);
+        do_action( 'gravityview_table_tr_before', \GravityView_View::getInstance() /** ugh! */ );
     }
 
     /**
@@ -516,7 +516,7 @@ 
      *
      * @return void
      */
-    public static function tr_after($context)
+    public static function tr_after( $context )
     {
         /**
          * @action `gravityview/template/table/tr/after` Output inside the `tr` of the table when there are no results.
@@ -525,7 +525,7 @@ 
          *
          * @param \GV\Template_Context $context The template context.
          */
-        do_action('gravityview/template/table/tr/after', $context);
+        do_action( 'gravityview/template/table/tr/after', $context );
 
         /**
          * @action `gravityview_table_tr_after` Inside the `tr` while rendering each entry in the loop. Can be used to insert additional table cells.
@@ -535,7 +535,7 @@ 
          *
          * @param \GravityView_View $gravityview_view Current GravityView_View object.
          */
-        do_action('gravityview_table_tr_after', \GravityView_View::getInstance() /** ugh! */);
+        do_action( 'gravityview_table_tr_after', \GravityView_View::getInstance() /** ugh! */ );
     }
 
     /**
@@ -549,7 +549,7 @@ 
      *
      * @return string The classes.
      */
-    public static function entry_class($class, $entry, $context)
+    public static function entry_class( $class, $entry, $context )
     {
         /**
          * @filter `gravityview_entry_class` Modify the class applied to the entry row.
@@ -562,7 +562,7 @@ 
          *
          * @return string The modified class.
          */
-        $class = apply_filters('gravityview_entry_class', $class, $entry->as_entry(), \GravityView_View::getInstance());
+        $class = apply_filters( 'gravityview_entry_class', $class, $entry->as_entry(), \GravityView_View::getInstance() );
 
         /**
          * @filter `gravityview/template/table/entry/class` Modify the class aplied to the entry row.
@@ -572,6 +572,6 @@ 
          *
          * @return string The modified class.
          */
-        return apply_filters('gravityview/template/table/entry/class', $class, Template_Context::from_template($context->template, compact('entry')));
+        return apply_filters( 'gravityview/template/table/entry/class', $class, Template_Context::from_template( $context->template, compact( 'entry' ) ) );
     }
 }

Braces +13 added lines, -26 removed lines

@@ -12,8 +12,7 @@ 
  *
  * Renders a \GV\View and a \GV\Entry_Collection via a \GV\View_Renderer.
  */
-class View_Table_Template extends View_Template
-{
+class View_Table_Template extends View_Template {
     /**
      * @var string The template slug to be loaded (like "table", "list")
      */
@@ -28,8 +27,7 @@ 
      * @param Entry_Collection $entries
      * @param Request          $request
      */
-    public function __construct(View $view, Entry_Collection $entries, Request $request)
-    {
+    public function __construct(View $view, Entry_Collection $entries, Request $request) {
         add_filter('gravityview/template/field/label', [__CLASS__, 'add_columns_sort_links'], 100, 2);
 
         parent::__construct($view, $entries, $request);
@@ -48,8 +46,7 @@ 
      *
      * @return string
      */
-    public static function add_columns_sort_links($column_label, $context = null)
-    {
+    public static function add_columns_sort_links($column_label, $context = null) {
         $sort_columns = $context->view->settings->get('sort_columns');
 
         if (empty($sort_columns)) {
@@ -153,8 +150,7 @@ 
      *
      * @return string Multisort URL, if there are multiple sorts. Otherwise, existing $url
      */
-    public static function _get_multisort_url($url, $sort_args, $field_id)
-    {
+    public static function _get_multisort_url($url, $sort_args, $field_id) {
         $sorts = Utils::_GET('sort');
 
         if (!is_array($sorts)) {
@@ -193,8 +189,7 @@ 
      *
      * @return void
      */
-    public function the_columns()
-    {
+    public function the_columns() {
         $fields = $this->view->fields->by_position('directory_table-columns');
 
         foreach ($fields->by_visible($this->view)->all() as $field) {
@@ -221,8 +216,7 @@ 
      * @param \GV\Field            $field
      * @param \GV\Template_Context $context
      */
-    protected static function get_field_column_label($field, $context = null)
-    {
+    protected static function get_field_column_label($field, $context = null) {
         $form = $field->form_id ? GF_Form::by_id($field->form_id) : $context->view->form;
 
         /**
@@ -252,8 +246,7 @@ 
      *
      * @return void
      */
-    public function the_entry(\GV\Entry $entry, $attributes)
-    {
+    public function the_entry(\GV\Entry $entry, $attributes) {
         $fields = $this->view->fields->by_position('directory_table-columns')->by_visible($this->view);
 
         $context = Template_Context::from_template($this, compact('entry', 'fields'));
@@ -370,8 +363,7 @@ 
      *
      * @return void
      */
-    public function the_field(\GV\Field $field, \GV\Entry $entry)
-    {
+    public function the_field(\GV\Field $field, \GV\Entry $entry) {
         $form = $this->view->form;
         $single_entry = $entry;
 
@@ -423,8 +415,7 @@ 
      *
      * @return void
      */
-    public static function body_before($context)
-    {
+    public static function body_before($context) {
         /**
          * @action `gravityview/template/table/body/before` Output inside the `tbody` of the table.
          *
@@ -454,8 +445,7 @@ 
      *
      * @return void
      */
-    public static function body_after($context)
-    {
+    public static function body_after($context) {
         /**
          * @action `gravityview/template/table/body/after` Output inside the `tbody` of the table at the end.
          *
@@ -485,8 +475,7 @@ 
      *
      * @return void
      */
-    public static function tr_before($context)
-    {
+    public static function tr_before($context) {
         /**
          * @action `gravityview/template/table/tr/before` Output inside the `tr` of the table when there are no results.
          *
@@ -516,8 +505,7 @@ 
      *
      * @return void
      */
-    public static function tr_after($context)
-    {
+    public static function tr_after($context) {
         /**
          * @action `gravityview/template/table/tr/after` Output inside the `tr` of the table when there are no results.
          *
@@ -549,8 +537,7 @@ 
      *
      * @return string The classes.
      */
-    public static function entry_class($class, $entry, $context)
-    {
+    public static function entry_class($class, $entry, $context) {
         /**
          * @filter `gravityview_entry_class` Modify the class applied to the entry row.
          *

future/includes/class-gv-entry-gravityforms.php

Indentation +177 added lines, -177 removed lines

@@ -4,7 +4,7 @@ 
 
 /** If this file is called directly, abort. */
 if (!defined('GRAVITYVIEW_DIR')) {
-    exit();
+	exit();
 }
 
 /**
@@ -14,180 +14,180 @@ 
  */
 class GF_Entry extends Entry implements \ArrayAccess
 {
-    /**
-     * @var string The identifier of the backend used for this entry.
-     *
-     * @api
-     *
-     * @since 2.0
-     */
-    public static $backend = 'gravityforms';
-
-    /**
-     * Initialization.
-     */
-    private function __construct()
-    {
-        if (!class_exists('GFAPI')) {
-            gravityview()->log->error('Gravity Forms plugin not active.');
-        }
-    }
-
-    /**
-     * Construct a \GV\Entry instance by ID.
-     *
-     * @param int|string $entry_id The internal entry ID.
-     * @param int        $form_id  The form ID, since slugs can be non-unique. Default: 0.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\GF_Entry|null An instance of this entry or null if not found.
-     */
-    public static function by_id($entry_id, $form_id = 0)
-    {
-        $entry = null;
-
-        /** Always try to grab by numeric ID first. */
-        if (is_numeric($entry_id)) {
-            $entry = \GFAPI::get_entry($entry_id);
-        }
-
-        if (!$entry || is_wp_error($entry)) {
-            /** Hmm, slugs? Must be. */
-            if (apply_filters('gravityview_custom_entry_slug', false)) {
-                return self::by_slug($entry_id, $form_id);
-            }
-
-            return null;
-        }
-
-        return self::from_entry($entry);
-    }
-
-    /**
-     * Construct a \GV\Entry instance by slug name.
-     *
-     * @param int|string $entry_slug The registered slug for the entry.
-     * @param int        $form_id    The form ID, since slugs can be non-unique. Default: 0.
-     *
-     * @api
-     *
-     * @since 2.0
-     *
-     * @return \GV\GF_Entry|null An instance of this entry or null if not found.
-     */
-    public static function by_slug($entry_slug, $form_id = 0)
-    {
-        global $wpdb;
-
-        if (version_compare(\GFFormsModel::get_database_version(), '2.3-dev-1', '>=')) {
-            $entry_meta = \GFFormsModel::get_entry_meta_table_name();
-            $sql = "SELECT entry_id FROM $entry_meta";
-        } else {
-            $lead_meta = \GFFormsModel::get_lead_meta_table_name();
-            $sql = "SELECT lead_id FROM $lead_meta";
-        }
-
-        $sql = "$sql WHERE meta_key = 'gravityview_unique_id' AND";
-
-        if ($form_id = apply_filters('gravityview/common/get_entry_id_from_slug/form_id', $form_id)) {
-            $sql = $wpdb->prepare("$sql meta_value = %s AND form_id = %s", $entry_slug, $form_id);
-        } else {
-            $sql = $wpdb->prepare("$sql meta_value = %s", $entry_slug);
-        }
-
-        $entry_id = $wpdb->get_var($sql);
-
-        if (!is_numeric($entry_id)) {
-            return null;
-        }
-
-        return self::by_id($entry_id);
-    }
-
-    /**
-     * Construct a \GV\Entry instance from a Gravity Forms entry array.
-     *
-     * @param array $entry The entry array
-     *
-     * @return \GV\GF_Entry|null An instance of this entry or null if not found.
-     */
-    public static function from_entry($entry)
-    {
-        if (empty($entry['id'])) {
-            return null;
-        }
-
-        $self = new self();
-        $self->entry = $entry;
-
-        $self->ID = $self->entry['id'];
-        $self->slug = $self->get_slug();
-
-        return $self;
-    }
-
-    /**
-     * ArrayAccess compatibility layer with a Gravity Forms entry array.
-     *
-     * @internal
-     *
-     * @deprecated
-     * @since 2.0
-     *
-     * @return bool Whether the offset exists or not.
-     */
-    public function offsetExists($offset)
-    {
-        return isset($this->entry[$offset]);
-    }
-
-    /**
-     * ArrayAccess compatibility layer with a Gravity Forms entry array.
-     *
-     * Maps the old keys to the new data;
-     *
-     * @internal
-     *
-     * @deprecated
-     * @since 2.0
-     *
-     * @return mixed The value of the requested entry data.
-     */
-    public function offsetGet($offset)
-    {
-        return $this->entry[$offset];
-    }
-
-    /**
-     * ArrayAccess compatibility layer with a Gravity Forms entry array.
-     *
-     * @internal
-     *
-     * @deprecated
-     * @since 2.0
-     *
-     * @return void
-     */
-    public function offsetSet($offset, $value)
-    {
-        gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
-    }
-
-    /**
-     * ArrayAccess compatibility layer with a Gravity Forms entry array.
-     *
-     * @internal
-     *
-     * @deprecated
-     * @since 2.0
-     *
-     * @return void
-     */
-    public function offsetUnset($offset)
-    {
-        gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
-    }
+	/**
+	 * @var string The identifier of the backend used for this entry.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 */
+	public static $backend = 'gravityforms';
+
+	/**
+	 * Initialization.
+	 */
+	private function __construct()
+	{
+		if (!class_exists('GFAPI')) {
+			gravityview()->log->error('Gravity Forms plugin not active.');
+		}
+	}
+
+	/**
+	 * Construct a \GV\Entry instance by ID.
+	 *
+	 * @param int|string $entry_id The internal entry ID.
+	 * @param int        $form_id  The form ID, since slugs can be non-unique. Default: 0.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\GF_Entry|null An instance of this entry or null if not found.
+	 */
+	public static function by_id($entry_id, $form_id = 0)
+	{
+		$entry = null;
+
+		/** Always try to grab by numeric ID first. */
+		if (is_numeric($entry_id)) {
+			$entry = \GFAPI::get_entry($entry_id);
+		}
+
+		if (!$entry || is_wp_error($entry)) {
+			/** Hmm, slugs? Must be. */
+			if (apply_filters('gravityview_custom_entry_slug', false)) {
+				return self::by_slug($entry_id, $form_id);
+			}
+
+			return null;
+		}
+
+		return self::from_entry($entry);
+	}
+
+	/**
+	 * Construct a \GV\Entry instance by slug name.
+	 *
+	 * @param int|string $entry_slug The registered slug for the entry.
+	 * @param int        $form_id    The form ID, since slugs can be non-unique. Default: 0.
+	 *
+	 * @api
+	 *
+	 * @since 2.0
+	 *
+	 * @return \GV\GF_Entry|null An instance of this entry or null if not found.
+	 */
+	public static function by_slug($entry_slug, $form_id = 0)
+	{
+		global $wpdb;
+
+		if (version_compare(\GFFormsModel::get_database_version(), '2.3-dev-1', '>=')) {
+			$entry_meta = \GFFormsModel::get_entry_meta_table_name();
+			$sql = "SELECT entry_id FROM $entry_meta";
+		} else {
+			$lead_meta = \GFFormsModel::get_lead_meta_table_name();
+			$sql = "SELECT lead_id FROM $lead_meta";
+		}
+
+		$sql = "$sql WHERE meta_key = 'gravityview_unique_id' AND";
+
+		if ($form_id = apply_filters('gravityview/common/get_entry_id_from_slug/form_id', $form_id)) {
+			$sql = $wpdb->prepare("$sql meta_value = %s AND form_id = %s", $entry_slug, $form_id);
+		} else {
+			$sql = $wpdb->prepare("$sql meta_value = %s", $entry_slug);
+		}
+
+		$entry_id = $wpdb->get_var($sql);
+
+		if (!is_numeric($entry_id)) {
+			return null;
+		}
+
+		return self::by_id($entry_id);
+	}
+
+	/**
+	 * Construct a \GV\Entry instance from a Gravity Forms entry array.
+	 *
+	 * @param array $entry The entry array
+	 *
+	 * @return \GV\GF_Entry|null An instance of this entry or null if not found.
+	 */
+	public static function from_entry($entry)
+	{
+		if (empty($entry['id'])) {
+			return null;
+		}
+
+		$self = new self();
+		$self->entry = $entry;
+
+		$self->ID = $self->entry['id'];
+		$self->slug = $self->get_slug();
+
+		return $self;
+	}
+
+	/**
+	 * ArrayAccess compatibility layer with a Gravity Forms entry array.
+	 *
+	 * @internal
+	 *
+	 * @deprecated
+	 * @since 2.0
+	 *
+	 * @return bool Whether the offset exists or not.
+	 */
+	public function offsetExists($offset)
+	{
+		return isset($this->entry[$offset]);
+	}
+
+	/**
+	 * ArrayAccess compatibility layer with a Gravity Forms entry array.
+	 *
+	 * Maps the old keys to the new data;
+	 *
+	 * @internal
+	 *
+	 * @deprecated
+	 * @since 2.0
+	 *
+	 * @return mixed The value of the requested entry data.
+	 */
+	public function offsetGet($offset)
+	{
+		return $this->entry[$offset];
+	}
+
+	/**
+	 * ArrayAccess compatibility layer with a Gravity Forms entry array.
+	 *
+	 * @internal
+	 *
+	 * @deprecated
+	 * @since 2.0
+	 *
+	 * @return void
+	 */
+	public function offsetSet($offset, $value)
+	{
+		gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
+	}
+
+	/**
+	 * ArrayAccess compatibility layer with a Gravity Forms entry array.
+	 *
+	 * @internal
+	 *
+	 * @deprecated
+	 * @since 2.0
+	 *
+	 * @return void
+	 */
+	public function offsetUnset($offset)
+	{
+		gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
+	}
 }

Spacing +29 added lines, -29 removed lines

@@ -3,7 +3,7 @@ 
 namespace GV;
 
 /** If this file is called directly, abort. */
-if (!defined('GRAVITYVIEW_DIR')) {
+if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
     exit();
 }
 
@@ -28,8 +28,8 @@ 
      */
     private function __construct()
     {
-        if (!class_exists('GFAPI')) {
-            gravityview()->log->error('Gravity Forms plugin not active.');
+        if ( ! class_exists( 'GFAPI' ) ) {
+            gravityview()->log->error( 'Gravity Forms plugin not active.' );
         }
     }
 
@@ -45,25 +45,25 @@ 
      *
      * @return \GV\GF_Entry|null An instance of this entry or null if not found.
      */
-    public static function by_id($entry_id, $form_id = 0)
+    public static function by_id( $entry_id, $form_id = 0 )
     {
         $entry = null;
 
         /** Always try to grab by numeric ID first. */
-        if (is_numeric($entry_id)) {
-            $entry = \GFAPI::get_entry($entry_id);
+        if ( is_numeric( $entry_id ) ) {
+            $entry = \GFAPI::get_entry( $entry_id );
         }
 
-        if (!$entry || is_wp_error($entry)) {
+        if ( ! $entry || is_wp_error( $entry ) ) {
             /** Hmm, slugs? Must be. */
-            if (apply_filters('gravityview_custom_entry_slug', false)) {
-                return self::by_slug($entry_id, $form_id);
+            if ( apply_filters( 'gravityview_custom_entry_slug', false ) ) {
+                return self::by_slug( $entry_id, $form_id );
             }
 
             return null;
         }
 
-        return self::from_entry($entry);
+        return self::from_entry( $entry );
     }
 
     /**
@@ -78,11 +78,11 @@ 
      *
      * @return \GV\GF_Entry|null An instance of this entry or null if not found.
      */
-    public static function by_slug($entry_slug, $form_id = 0)
+    public static function by_slug( $entry_slug, $form_id = 0 )
     {
         global $wpdb;
 
-        if (version_compare(\GFFormsModel::get_database_version(), '2.3-dev-1', '>=')) {
+        if ( version_compare( \GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) ) {
             $entry_meta = \GFFormsModel::get_entry_meta_table_name();
             $sql = "SELECT entry_id FROM $entry_meta";
         } else {
@@ -92,19 +92,19 @@ 
 
         $sql = "$sql WHERE meta_key = 'gravityview_unique_id' AND";
 
-        if ($form_id = apply_filters('gravityview/common/get_entry_id_from_slug/form_id', $form_id)) {
-            $sql = $wpdb->prepare("$sql meta_value = %s AND form_id = %s", $entry_slug, $form_id);
+        if ( $form_id = apply_filters( 'gravityview/common/get_entry_id_from_slug/form_id', $form_id ) ) {
+            $sql = $wpdb->prepare( "$sql meta_value = %s AND form_id = %s", $entry_slug, $form_id );
         } else {
-            $sql = $wpdb->prepare("$sql meta_value = %s", $entry_slug);
+            $sql = $wpdb->prepare( "$sql meta_value = %s", $entry_slug );
         }
 
-        $entry_id = $wpdb->get_var($sql);
+        $entry_id = $wpdb->get_var( $sql );
 
-        if (!is_numeric($entry_id)) {
+        if ( ! is_numeric( $entry_id ) ) {
             return null;
         }
 
-        return self::by_id($entry_id);
+        return self::by_id( $entry_id );
     }
 
     /**
@@ -114,16 +114,16 @@ 
      *
      * @return \GV\GF_Entry|null An instance of this entry or null if not found.
      */
-    public static function from_entry($entry)
+    public static function from_entry( $entry )
     {
-        if (empty($entry['id'])) {
+        if ( empty( $entry[ 'id' ] ) ) {
             return null;
         }
 
         $self = new self();
         $self->entry = $entry;
 
-        $self->ID = $self->entry['id'];
+        $self->ID = $self->entry[ 'id' ];
         $self->slug = $self->get_slug();
 
         return $self;
@@ -139,9 +139,9 @@ 
      *
      * @return bool Whether the offset exists or not.
      */
-    public function offsetExists($offset)
+    public function offsetExists( $offset )
     {
-        return isset($this->entry[$offset]);
+        return isset( $this->entry[ $offset ] );
     }
 
     /**
@@ -156,9 +156,9 @@ 
      *
      * @return mixed The value of the requested entry data.
      */
-    public function offsetGet($offset)
+    public function offsetGet( $offset )
     {
-        return $this->entry[$offset];
+        return $this->entry[ $offset ];
     }
 
     /**
@@ -171,9 +171,9 @@ 
      *
      * @return void
      */
-    public function offsetSet($offset, $value)
+    public function offsetSet( $offset, $value )
     {
-        gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
+        gravityview()->log->error( 'The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.' );
     }
 
     /**
@@ -186,8 +186,8 @@ 
      *
      * @return void
      */
-    public function offsetUnset($offset)
+    public function offsetUnset( $offset )
     {
-        gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
+        gravityview()->log->error( 'The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.' );
     }
 }

Braces +8 added lines, -16 removed lines

@@ -26,8 +26,7 @@ 
     /**
      * Initialization.
      */
-    private function __construct()
-    {
+    private function __construct() {
         if (!class_exists('GFAPI')) {
             gravityview()->log->error('Gravity Forms plugin not active.');
         }
@@ -45,8 +44,7 @@ 
      *
      * @return \GV\GF_Entry|null An instance of this entry or null if not found.
      */
-    public static function by_id($entry_id, $form_id = 0)
-    {
+    public static function by_id($entry_id, $form_id = 0) {
         $entry = null;
 
         /** Always try to grab by numeric ID first. */
@@ -78,8 +76,7 @@ 
      *
      * @return \GV\GF_Entry|null An instance of this entry or null if not found.
      */
-    public static function by_slug($entry_slug, $form_id = 0)
-    {
+    public static function by_slug($entry_slug, $form_id = 0) {
         global $wpdb;
 
         if (version_compare(\GFFormsModel::get_database_version(), '2.3-dev-1', '>=')) {
@@ -114,8 +111,7 @@ 
      *
      * @return \GV\GF_Entry|null An instance of this entry or null if not found.
      */
-    public static function from_entry($entry)
-    {
+    public static function from_entry($entry) {
         if (empty($entry['id'])) {
             return null;
         }
@@ -139,8 +135,7 @@ 
      *
      * @return bool Whether the offset exists or not.
      */
-    public function offsetExists($offset)
-    {
+    public function offsetExists($offset) {
         return isset($this->entry[$offset]);
     }
 
@@ -156,8 +151,7 @@ 
      *
      * @return mixed The value of the requested entry data.
      */
-    public function offsetGet($offset)
-    {
+    public function offsetGet($offset) {
         return $this->entry[$offset];
     }
 
@@ -171,8 +165,7 @@ 
      *
      * @return void
      */
-    public function offsetSet($offset, $value)
-    {
+    public function offsetSet($offset, $value) {
         gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
     }
 
@@ -186,8 +179,7 @@ 
      *
      * @return void
      */
-    public function offsetUnset($offset)
-    {
+    public function offsetUnset($offset) {
         gravityview()->log->error('The underlying Gravity Forms entry is immutable. This is a \GV\Entry object and should not be accessed as an array.');
     }
 }