Entry::add_rewrite_endpoint() - Code Metrics - Inspection of "Merge pull request #836 from gravityview/develop" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d07b76...196a0a )

by Zack

created 2017-02-24 18:59 UTC

Entry::add_rewrite_endpoint() A

↳ Parent: Entry

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.0932

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	6
nc	2
nop	0
dl	0
loc	11
ccs	5
cts	7
cp	0.7143
crap	2.0932
rs	9.4285
c	1
b	0
f	0

<?php

namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) )
// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
	die();

/**
 * The base Entry class.
 *
 * Contains all entry data and some processing and logic rules.
 */
class 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
}

		$endpoint = self::get_endpoint_name();

		/** Let's make sure the endpoint array is not polluted. */
		if ( in_array( array( EP_ALL, $endpoint, $endpoint ), $wp_rewrite->endpoints ) )
// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
			return;

		add_rewrite_endpoint( $endpoint, EP_ALL );
	}

	/**
	 * 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 );
	}
}


Push — master ( d07b76...196a0a )

Entry::add_rewrite_endpoint() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

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 13 and the first side effect is on line 5. 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' ) )
		0 ignored issues – show Coding Style Best Practice introduced 2017-01-22 20:12 UTC by Report Bug Copy Issue Report It is generally a best practice to always use braces with control structures. Adding braces to control structures avoids accidental mistakes as your code changes: // Without braces (not recommended) if (true) doSomething(); // Recommended if (true) { doSomething(); } Loading history...
6		die();
7
8		/**
9		* The base Entry class.
10		*
11		* Contains all entry data and some processing and logic rules.
12		*/
13		class Entry {
14
15		/**
16		* Adds the necessary rewrites for single Entries.
17		*
18		* @internal
19		* @return void
20		*/
21	1	public static function add_rewrite_endpoint() {
22	1	global $wp_rewrite;
		0 ignored issues – show Compatibility Best Practice introduced 2017-01-22 20:12 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...
23
24	1	$endpoint = self::get_endpoint_name();
25
26		/** Let's make sure the endpoint array is not polluted. */
27	1	if ( in_array( array( EP_ALL, $endpoint, $endpoint ), $wp_rewrite->endpoints ) )
		0 ignored issues – show Coding Style Best Practice introduced 2017-01-22 20:12 UTC by Report Bug Copy Issue Report It is generally a best practice to always use braces with control structures. Adding braces to control structures avoids accidental mistakes as your code changes: // Without braces (not recommended) if (true) doSomething(); // Recommended if (true) { doSomething(); } Loading history...
28	1	return;
29
30		add_rewrite_endpoint( $endpoint, EP_ALL );
31		}
32
33		/**
34		* Return the endpoint name for a single Entry.
35		*
36		* Also used as the query_var for the time being.
37		*
38		* @internal
39		* @return string The name. Default: "entry"
40		*/
41	2	public static function get_endpoint_name() {
42		/**
43		* @filter `gravityview_directory_endpoint` Change the slug used for single entries
44		* @param[in,out] string $endpoint Slug to use when accessing single entry. Default: `entry`
45		*/
46	2	$endpoint = apply_filters( 'gravityview_directory_endpoint', 'entry' );
47
48	2	return sanitize_title( $endpoint );
49		}
50		}
51

gravityview / GravityView

Push — master ( d07b76...196a0a )

Entry::add_rewrite_endpoint() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like