Entry::as_entry() - Code Metrics - Inspection of "Version 1.21.2" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#869)

by Zack

created 2017-04-01 00:17 UTC

Entry::as_entry() A

↳ Parent: Entry

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?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 future
	 */
	public static $backend = null;

	/**
	 * @var int The ID for this entry.
	 *
	 * @api
	 * @since future
	 */
	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
}

		$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 ) ) {
			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 );
	}

	/**
	 * Construct a \GV\Entry instance by ID.
	 *
	 * @param int|string $entry_id The internal entry ID.
	 *
	 * @api
	 * @since future
	 * @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;
	}
}


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 future
20		*/
21		public static $backend = null;
22
23		/**
24		* @var int The ID for this entry.
25		*
26		* @api
27		* @since future
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 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...
44
45	1	$endpoint = self::get_endpoint_name();
46
47		/** Let's make sure the endpoint array is not polluted. */
48	1	if ( in_array( array( EP_ALL, $endpoint, $endpoint ), $wp_rewrite->endpoints ) ) {
49	1	return;
50		}
51
52		add_rewrite_endpoint( $endpoint, EP_ALL );
53		}
54
55		/**
56		* Return the endpoint name for a single Entry.
57		*
58		* Also used as the query_var for the time being.
59		*
60		* @internal
61		* @return string The name. Default: "entry"
62		*/
63	3	public static function get_endpoint_name() {
64		/**
65		* @filter `gravityview_directory_endpoint` Change the slug used for single entries
66		* @param[in,out] string $endpoint Slug to use when accessing single entry. Default: `entry`
67		*/
68	3	$endpoint = apply_filters( 'gravityview_directory_endpoint', 'entry' );
69
70	3	return sanitize_title( $endpoint );
71		}
72
73		/**
74		* Construct a \GV\Entry instance by ID.
75		*
76		* @param int\|string $entry_id The internal entry ID.
77		*
78		* @api
79		* @since future
80		* @return \GV\Entry\|null An instance of this entry or null if not found.
81		*/
82		public static function by_id( $entry_id ) {
83		return null;
84		}
85
86		/**
87		* Return the backing entry object.
88		*
89		* @return array The backing entry object.
90		*/
91		public function as_entry() {
92		return $this->entry;
93		}
94		}
95

gravityview / GravityView

Pull Request — master (#869)

Entry::as_entry() 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