Entry - Code Metrics - Inspection of "Much less rewrite polution for /entry/ endpoint" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 0c0247...72e40e )

by Gennady

created 2018-07-29 20:49 UTC

Entry A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

90%

Importance

Changes

Metric	Value
dl	0
loc	180
ccs	45
cts	50
cp	0.9
rs	10
c	0
b	0
f	0
wmc	21
lcom	1
cbo	3

5 Methods

Rating	Name	Size	Complexity
A	add_rewrite_endpoint()	16	2
A	get_endpoint_name()	9	1
A	by_id()	3	1
A	as_entry()	3	1
F	get_permalink()	82	16

<?php

namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
	die();
}

/**
 * The base \GV\Entry class.
 *
 * Contains all entry data and some processing and logic rules.
 */
abstract class Entry {

	/**
	 * @var string The identifier of the backend used for this entry.
	 * @api
	 * @since 2.0
	 */
	public static $backend = null;

	/**
	 * @var int The ID for this entry.
	 *
	 * @api
	 * @since 2.0
	 */
	public $ID = null;

	/**
	 * @var mixed The backing entry.
	 */
	protected $entry;
	
	/**
	 * Adds the necessary rewrites for single Entries.
	 *
	 * @internal
	 * @return void
	 */
	public static function add_rewrite_endpoint() {
		global $wp_rewrite;
function myFunction($a, $b) {
    // Do something
}

		$slug = apply_filters( 'gravityview_slug', 'view' );
		$endpoint = self::get_endpoint_name();
		$rule = array( sprintf( '%s/([^/]+)/%s(/(.*))?/?$', $slug, $endpoint ), sprintf( 'index.php?gravityview=$matches[1]&%s=$matches[3]', $endpoint ), 'top' );

		add_filter( 'query_vars', function( $query_vars ) use ( $endpoint ) {
			$query_vars[] = $endpoint;
			return $query_vars;
		} );

		if ( ! isset( $wp_rewrite->extra_rules_top[ $rule[0] ] ) ) {
			call_user_func_array( 'add_rewrite_rule', $rule );
		}
	}

	/**
	 * Return the endpoint name for a single Entry.
	 *
	 * Also used as the query_var for the time being.
	 *
	 * @internal
	 * @return string The name. Default: "entry"
	 */
	public static function get_endpoint_name() {
		/**
		 * @filter `gravityview_directory_endpoint` Change the slug used for single entries
		 * @param[in,out] string $endpoint Slug to use when accessing single entry. Default: `entry`
		 */
		$endpoint = apply_filters( 'gravityview_directory_endpoint', 'entry' );

		return sanitize_title( $endpoint );
	}

	/**
	 * Construct a \GV\Entry instance by ID.
	 *
	 * @param int|string $entry_id The internal entry ID.
	 *
	 * @api
	 * @since 2.0
	 * @return \GV\Entry|null An instance of this entry or null if not found.
	 */
	public static function by_id( $entry_id ) {
		return null;
	}

	/**
	 * Return the backing entry object.
	 *
	 * @return array The backing entry object.
	 */
	public function as_entry() {
		return $this->entry;
	}

	/**
	 * Return the link to this entry in the supplied context.
	 *
	 * @api
	 * @since 2.0
	 *
	 * @param \GV\View|null $view The View context.
	 * @param \GV\Request $request The Request (current if null).
	 * @param boolean $track_directory Keep the housing directory arguments intact (used for breadcrumbs, for example). Default: true.
	 *
	 * @return string The permalink to this entry.
	 */
	public function get_permalink( \GV\View $view = null, \GV\Request $request = null, $track_directory = true ) {
		if ( is_null( $request ) ) {
			$request = &gravityview()->request;
		}

		global $post;
function myFunction($a, $b) {
    // Do something
}

		$args = array();

		$view_id = is_null ( $view ) ? null : $view->ID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		$permalink = null;

		/** This is not a regular view. */
		if ( ! $request->is_view() ) {

			/** Must be an embed of some sort. */
			if ( is_object( $post ) && is_numeric( $post->ID ) ) {
				$permalink = get_permalink( $post->ID );

				$view_collection = View_Collection::from_post( $post );

				if( 1 < $view_collection->count() ) {
					$args['gvid'] = $view_id;
				}
			}
		}
		
		/** Fallback to regular view base. */
		if ( is_null( $permalink ) ) {
			$permalink = get_permalink( $view_id );
		}

		/**
		 * @filter `gravityview_directory_link` Modify the URL to the View "directory" context
		 * @since 1.19.4
		 * @param string $link URL to the View's "directory" context (Multiple Entries screen)
		 * @param int $post_id ID of the post to link to. If the View is embedded, it is the post or page ID
		 */
		$permalink = apply_filters( 'gravityview_directory_link', $permalink, $request->is_view() ? $view_id : ( $post ? $post->ID : null ) );

		$entry_endpoint_name = \GV\Entry::get_endpoint_name();
		$entry_slug = \GravityView_API::get_entry_slug( $this->ID, $this->as_entry() );

		/** Assemble the permalink. */
		if ( get_option( 'permalink_structure' ) && ! is_preview() ) {
			/**
			 * Make sure the $directory_link doesn't contain any query otherwise it will break when adding the entry slug.
			 * @since 1.16.5
			 */
			$link_parts = explode( '?', $permalink );

			$query = ! empty( $link_parts[1] ) ? '?' . $link_parts[1] : '';

			$permalink = trailingslashit( $link_parts[0] ) . $entry_endpoint_name . '/'. $entry_slug .'/' . $query;
		} else {
			$args[ $entry_endpoint_name ] = $entry_slug;
		}

		if ( $track_directory ) {
			if ( ! empty( $_GET['pagenum'] ) ) {
				$args['pagenum'] = intval( $_GET['pagenum'] );

			}

			if ( $sort = Utils::_GET( 'sort' ) ) {
				$args['sort'] = $sort;
				$args['dir'] = Utils::_GET( 'dir' );
			}
		}

		$permalink = add_query_arg( $args, $permalink );

		/**
		 * @filter `gravityview/entry/permalink` The permalink of this entry.
		 * @since 2.0
		 * @param string $permalink The permalink.
		 * @param \GV\Entry $entry The entry we're retrieving it for.
		 * @param \GV\View|null $view The view context.
		 * @param \GV\Request $reqeust The request context.
		 */
		return apply_filters( 'gravityview/entry/permalink', $permalink, $this, $view, $request );
	}
}


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-01-22 20:12 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 14 and the first side effect is on line 6. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		namespace GV;
3
4		/** If this file is called directly, abort. */
5		if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
6		die();
7		}
8
9		/**
10		* The base \GV\Entry class.
11		*
12		* Contains all entry data and some processing and logic rules.
13		*/
14		abstract class Entry {
15
16		/**
17		* @var string The identifier of the backend used for this entry.
18		* @api
19		* @since 2.0
20		*/
21		public static $backend = null;
22
23		/**
24		* @var int The ID for this entry.
25		*
26		* @api
27		* @since 2.0
28		*/
29		public $ID = null;
30
31		/**
32		* @var mixed The backing entry.
33		*/
34		protected $entry;
35
36		/**
37		* Adds the necessary rewrites for single Entries.
38		*
39		* @internal
40		* @return void
41		*/
42	1	public static function add_rewrite_endpoint() {
43	1	global $wp_rewrite;
		0 ignored issues – show Compatibility Best Practice introduced 2018-07-29 21:05 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
44
45	1	$slug = apply_filters( 'gravityview_slug', 'view' );
46	1	$endpoint = self::get_endpoint_name();
47	1	$rule = array( sprintf( '%s/([^/]+)/%s(/(.*))?/?$', $slug, $endpoint ), sprintf( 'index.php?gravityview=$matches[1]&%s=$matches[3]', $endpoint ), 'top' );
48
49	1	add_filter( 'query_vars', function( $query_vars ) use ( $endpoint ) {
50		$query_vars[] = $endpoint;
51		return $query_vars;
52	1	} );
53
54	1	if ( ! isset( $wp_rewrite->extra_rules_top[ $rule[0] ] ) ) {
55		call_user_func_array( 'add_rewrite_rule', $rule );
56		}
57	1	}
58
59		/**
60		* Return the endpoint name for a single Entry.
61		*
62		* Also used as the query_var for the time being.
63		*
64		* @internal
65		* @return string The name. Default: "entry"
66		*/
67	27	public static function get_endpoint_name() {
68		/**
69		* @filter `gravityview_directory_endpoint` Change the slug used for single entries
70		* @param[in,out] string $endpoint Slug to use when accessing single entry. Default: `entry`
71		*/
72	27	$endpoint = apply_filters( 'gravityview_directory_endpoint', 'entry' );
73
74	27	return sanitize_title( $endpoint );
75		}
76
77		/**
78		* Construct a \GV\Entry instance by ID.
79		*
80		* @param int\|string $entry_id The internal entry ID.
81		*
82		* @api
83		* @since 2.0
84		* @return \GV\Entry\|null An instance of this entry or null if not found.
85		*/
86		public static function by_id( $entry_id ) {
87		return null;
88		}
89
90		/**
91		* Return the backing entry object.
92		*
93		* @return array The backing entry object.
94		*/
95	65	public function as_entry() {
96	65	return $this->entry;
97		}
98
99		/**
100		* Return the link to this entry in the supplied context.
101		*
102		* @api
103		* @since 2.0
104		*
105		* @param \GV\View\|null $view The View context.
106		* @param \GV\Request $request The Request (current if null).
107		* @param boolean $track_directory Keep the housing directory arguments intact (used for breadcrumbs, for example). Default: true.
108		*
109		* @return string The permalink to this entry.
110		*/
111	7	public function get_permalink( \GV\View $view = null, \GV\Request $request = null, $track_directory = true ) {
112	7	if ( is_null( $request ) ) {
113	1	$request = &gravityview()->request;
114		}
115
116	7	global $post;
		0 ignored issues – show Compatibility Best Practice introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
117
118	7	$args = array();
119
120	7	$view_id = is_null ( $view ) ? null : $view->ID;
		0 ignored issues – show Documentation introduced 2018-05-21 22:31 UTC by Report Bug Copy Issue Report The property `ID` does not exist on `object<GV\View>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Coding Style introduced 2018-05-21 22:31 UTC by Report Bug Copy Issue Report Space before opening parenthesis of function call prohibited Loading history...
121
122	7	$permalink = null;
123
124		/** This is not a regular view. */
125	7	if ( ! $request->is_view() ) {
126
127		/** Must be an embed of some sort. */
128	5	if ( is_object( $post ) && is_numeric( $post->ID ) ) {
129	1	$permalink = get_permalink( $post->ID );
130
131	1	$view_collection = View_Collection::from_post( $post );
132
133	1	if( 1 < $view_collection->count() ) {
134	1	$args['gvid'] = $view_id;
135		}
136		}
137		}
138
139		/** Fallback to regular view base. */
140	7	if ( is_null( $permalink ) ) {
141	7	$permalink = get_permalink( $view_id );
142		}
143
144		/**
145		* @filter `gravityview_directory_link` Modify the URL to the View "directory" context
146		* @since 1.19.4
147		* @param string $link URL to the View's "directory" context (Multiple Entries screen)
148		* @param int $post_id ID of the post to link to. If the View is embedded, it is the post or page ID
149		*/
150	7	$permalink = apply_filters( 'gravityview_directory_link', $permalink, $request->is_view() ? $view_id : ( $post ? $post->ID : null ) );
151
152	7	$entry_endpoint_name = \GV\Entry::get_endpoint_name();
153	7	$entry_slug = \GravityView_API::get_entry_slug( $this->ID, $this->as_entry() );
154
155		/** Assemble the permalink. */
156	7	if ( get_option( 'permalink_structure' ) && ! is_preview() ) {
157		/**
158		* Make sure the $directory_link doesn't contain any query otherwise it will break when adding the entry slug.
159		* @since 1.16.5
160		*/
161	1	$link_parts = explode( '?', $permalink );
162
163	1	$query = ! empty( $link_parts[1] ) ? '?' . $link_parts[1] : '';
164
165	1	$permalink = trailingslashit( $link_parts[0] ) . $entry_endpoint_name . '/'. $entry_slug .'/' . $query;
166		} else {
167	7	$args[ $entry_endpoint_name ] = $entry_slug;
168		}
169
170	7	if ( $track_directory ) {
171	7	if ( ! empty( $_GET['pagenum'] ) ) {
172	1	$args['pagenum'] = intval( $_GET['pagenum'] );
		0 ignored issues – show introduced 2018-05-08 22:40 UTC by Report Bug Copy Issue Report Detected access of super global var $_GET, probably need manual inspection. Loading history...
173		}
174
175	7	if ( $sort = Utils::_GET( 'sort' ) ) {
176	1	$args['sort'] = $sort;
177	1	$args['dir'] = Utils::_GET( 'dir' );
178		}
179		}
180
181	7	$permalink = add_query_arg( $args, $permalink );
182
183		/**
184		* @filter `gravityview/entry/permalink` The permalink of this entry.
185		* @since 2.0
186		* @param string $permalink The permalink.
187		* @param \GV\Entry $entry The entry we're retrieving it for.
188		* @param \GV\View\|null $view The view context.
189		* @param \GV\Request $reqeust The request context.
190		*/
191	7	return apply_filters( 'gravityview/entry/permalink', $permalink, $this, $view, $request );
192		}
193		}
194

gravityview / GravityView

Push — develop ( 0c0247...72e40e )

Entry A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like