WP_Term::__get() - Code Metrics - Inspection of "Merge branch 'master' of git://develop.git.wordpre..." - ntwb/wordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a7cd2a...eabd6c )

by Stephen

created 2016-03-16 21:52 UTC

WP_Term::__get() A

↳ Parent: WP_Term

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	13
rs	9.2
cc	4
eloc	9
nc	4
nop	1

<?php
/**
 * Taxonomy API: WP_Term class
 *
 * @package WordPress
 * @subpackage Taxonomy
 * @since 4.4.0
 */

/**
 * Core class used to implement the WP_Term object.
 *
 * @since 4.4.0
 */
final class WP_Term {

	/**
	 * Term ID.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var int
	 */
	public $term_id;

	/**
	 * The term's name.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var string
	 */
	public $name = '';

	/**
	 * The term's slug.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var string
	 */
	public $slug = '';

	/**
	 * The term's term_group.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var string
	 */
	public $term_group = '';

	/**
	 * Term Taxonomy ID.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var int
	 */
	public $term_taxonomy_id = 0;

	/**
	 * The term's taxonomy name.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var string
	 */
	public $taxonomy = '';

	/**
	 * The term's description.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var string
	 */
	public $description = '';

	/**
	 * ID of a term's parent term.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var int
	 */
	public $parent = 0;

	/**
	 * Cached object count for this term.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var int
	 */
	public $count = 0;

	/**
	 * Stores the term object's sanitization level.
	 *
	 * Does not correspond to a database field.
	 *
	 * @since 4.4.0
	 * @access public
	 * @var string
	 */
	public $filter = 'raw';

	/**
	 * Retrieve WP_Term instance.
	 *
	 * @since 4.4.0
	 * @access public
	 * @static
	 *
	 * @global wpdb $wpdb WordPress database abstraction object.
	 *
	 * @param int    $term_id  Term ID.
	 * @param string $taxonomy Optional. Limit matched terms to those matching `$taxonomy`. Only used for
	 *                         disambiguating potentially shared terms.
	 * @return WP_Term|WP_Error|false Term object, if found. WP_Error if `$term_id` is shared between taxonomies and
	 *                                there's insufficient data to distinguish which term is intended.
	 *                                False for other failures.
	 */
	public static function get_instance( $term_id, $taxonomy = null ) {
		global $wpdb;

		$term_id = (int) $term_id;
		if ( ! $term_id ) {
			return false;
		}

		$_term = wp_cache_get( $term_id, 'terms' );

		// If there isn't a cached version, hit the database.
		if ( ! $_term || ( $taxonomy && $taxonomy !== $_term->taxonomy ) ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			// Grab all matching terms, in case any are shared between taxonomies.
			$terms = $wpdb->get_results( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id = %d", $term_id ) );
			if ( ! $terms ) {
				return false;
			}

			// If a taxonomy was specified, find a match.
			if ( $taxonomy ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				foreach ( $terms as $match ) {
					if ( $taxonomy === $match->taxonomy ) {
						$_term = $match;
						break;
					}
				}

			// If only one match was found, it's the one we want.
			} elseif ( 1 === count( $terms ) ) {
				$_term = reset( $terms );

			// Otherwise, the term must be shared between taxonomies.
			} else {
				// If the term is shared only with invalid taxonomies, return the one valid term.
				foreach ( $terms as $t ) {
					if ( ! taxonomy_exists( $t->taxonomy ) ) {
						continue;
					}

					// Only hit if we've already identified a term in a valid taxonomy.
					if ( $_term ) {
						return new WP_Error( 'ambiguous_term_id', __( 'Term ID is shared between multiple taxonomies' ), $term_id );
					}

					$_term = $t;
				}
			}

			if ( ! $_term ) {
				return false;
			}

			// Don't return terms from invalid taxonomies.
			if ( ! taxonomy_exists( $_term->taxonomy ) ) {
				return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
			}

			$_term = sanitize_term( $_term, $_term->taxonomy, 'raw' );

			// Don't cache terms that are shared between taxonomies.
			if ( 1 === count( $terms ) ) {
				wp_cache_add( $term_id, $_term, 'terms' );
			}
		}

		$term_obj = new WP_Term( $_term );
		$term_obj->filter( $term_obj->filter );

		return $term_obj;
	}

	/**
	 * Constructor.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param WP_Term|object $term Term object.
	 */
	public function __construct( $term ) {
		foreach ( get_object_vars( $term ) as $key => $value ) {
			$this->$key = $value;
		}
	}

	/**
	 * Sanitizes term fields, according to the filter type provided.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param string $filter Filter context. Accepts 'edit', 'db', 'display', 'attribute', 'js', 'raw'.
	 */
	public function filter( $filter ) {
		sanitize_term( $this, $this->taxonomy, $filter );
	}

	/**
	 * Converts an object to array.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @return array Object as array.
	 */
	public function to_array() {
		return get_object_vars( $this );
	}

	/**
	 * Getter.
	 *
	 * @since 4.4.0
	 * @access public
	 *
	 * @param string $key Property to get.
	 * @return mixed Property value.
	 */
	public function __get( $key ) {
		switch ( $key ) {
			case 'data' :
				$data = new stdClass();
				$columns = array( 'term_id', 'name', 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description', 'parent', 'count' );
				foreach ( $columns as $column ) {
					$data->{$column} = isset( $this->{$column} ) ? $this->{$column} : null;
				}

				return sanitize_term( $data, $data->taxonomy, 'raw' );
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
		}
	}
}


1			<?php
2			/**
3			* Taxonomy API: WP_Term class
4			*
5			* @package WordPress
6			* @subpackage Taxonomy
7			* @since 4.4.0
8			*/
9
10			/**
11			* Core class used to implement the WP_Term object.
12			*
13			* @since 4.4.0
14			*/
15			final class WP_Term {
16
17			/**
18			* Term ID.
19			*
20			* @since 4.4.0
21			* @access public
22			* @var int
23			*/
24			public $term_id;
25
26			/**
27			* The term's name.
28			*
29			* @since 4.4.0
30			* @access public
31			* @var string
32			*/
33			public $name = '';
34
35			/**
36			* The term's slug.
37			*
38			* @since 4.4.0
39			* @access public
40			* @var string
41			*/
42			public $slug = '';
43
44			/**
45			* The term's term_group.
46			*
47			* @since 4.4.0
48			* @access public
49			* @var string
50			*/
51			public $term_group = '';
52
53			/**
54			* Term Taxonomy ID.
55			*
56			* @since 4.4.0
57			* @access public
58			* @var int
59			*/
60			public $term_taxonomy_id = 0;
61
62			/**
63			* The term's taxonomy name.
64			*
65			* @since 4.4.0
66			* @access public
67			* @var string
68			*/
69			public $taxonomy = '';
70
71			/**
72			* The term's description.
73			*
74			* @since 4.4.0
75			* @access public
76			* @var string
77			*/
78			public $description = '';
79
80			/**
81			* ID of a term's parent term.
82			*
83			* @since 4.4.0
84			* @access public
85			* @var int
86			*/
87			public $parent = 0;
88
89			/**
90			* Cached object count for this term.
91			*
92			* @since 4.4.0
93			* @access public
94			* @var int
95			*/
96			public $count = 0;
97
98			/**
99			* Stores the term object's sanitization level.
100			*
101			* Does not correspond to a database field.
102			*
103			* @since 4.4.0
104			* @access public
105			* @var string
106			*/
107			public $filter = 'raw';
108
109			/**
110			* Retrieve WP_Term instance.
111			*
112			* @since 4.4.0
113			* @access public
114			* @static
115			*
116			* @global wpdb $wpdb WordPress database abstraction object.
117			*
118			* @param int $term_id Term ID.
119			* @param string $taxonomy Optional. Limit matched terms to those matching `$taxonomy`. Only used for
120			* disambiguating potentially shared terms.
121			* @return WP_Term\|WP_Error\|false Term object, if found. WP_Error if `$term_id` is shared between taxonomies and
122			* there's insufficient data to distinguish which term is intended.
123			* False for other failures.
124			*/
125			public static function get_instance( $term_id, $taxonomy = null ) {
126			global $wpdb;
127
128			$term_id = (int) $term_id;
129			if ( ! $term_id ) {
130			return false;
131			}
132
133			$_term = wp_cache_get( $term_id, 'terms' );
134
135			// If there isn't a cached version, hit the database.
136			if ( ! $_term \|\| ( $taxonomy && $taxonomy !== $_term->taxonomy ) ) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-16 22:18 UTC by Report Bug Copy Issue Report The expression `$taxonomy` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
137			// Grab all matching terms, in case any are shared between taxonomies.
138			$terms = $wpdb->get_results( $wpdb->prepare( "SELECT t., tt. FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id = %d", $term_id ) );
139			if ( ! $terms ) {
140			return false;
141			}
142
143			// If a taxonomy was specified, find a match.
144			if ( $taxonomy ) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-16 22:18 UTC by Report Bug Copy Issue Report The expression `$taxonomy` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
145			foreach ( $terms as $match ) {
146			if ( $taxonomy === $match->taxonomy ) {
147			$_term = $match;
148			break;
149			}
150			}
151
152			// If only one match was found, it's the one we want.
153			} elseif ( 1 === count( $terms ) ) {
154			$_term = reset( $terms );
155
156			// Otherwise, the term must be shared between taxonomies.
157			} else {
158			// If the term is shared only with invalid taxonomies, return the one valid term.
159			foreach ( $terms as $t ) {
160			if ( ! taxonomy_exists( $t->taxonomy ) ) {
161			continue;
162			}
163
164			// Only hit if we've already identified a term in a valid taxonomy.
165			if ( $_term ) {
166			return new WP_Error( 'ambiguous_term_id', __( 'Term ID is shared between multiple taxonomies' ), $term_id );
167			}
168
169			$_term = $t;
170			}
171			}
172
173			if ( ! $_term ) {
174			return false;
175			}
176
177			// Don't return terms from invalid taxonomies.
178			if ( ! taxonomy_exists( $_term->taxonomy ) ) {
179			return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
180			}
181
182			$_term = sanitize_term( $_term, $_term->taxonomy, 'raw' );
183
184			// Don't cache terms that are shared between taxonomies.
185			if ( 1 === count( $terms ) ) {
186			wp_cache_add( $term_id, $_term, 'terms' );
187			}
188			}
189
190			$term_obj = new WP_Term( $_term );
191			$term_obj->filter( $term_obj->filter );
192
193			return $term_obj;
194			}
195
196			/**
197			* Constructor.
198			*
199			* @since 4.4.0
200			* @access public
201			*
202			* @param WP_Term\|object $term Term object.
203			*/
204			public function __construct( $term ) {
205			foreach ( get_object_vars( $term ) as $key => $value ) {
206			$this->$key = $value;
207			}
208			}
209
210			/**
211			* Sanitizes term fields, according to the filter type provided.
212			*
213			* @since 4.4.0
214			* @access public
215			*
216			* @param string $filter Filter context. Accepts 'edit', 'db', 'display', 'attribute', 'js', 'raw'.
217			*/
218			public function filter( $filter ) {
219			sanitize_term( $this, $this->taxonomy, $filter );
220			}
221
222			/**
223			* Converts an object to array.
224			*
225			* @since 4.4.0
226			* @access public
227			*
228			* @return array Object as array.
229			*/
230			public function to_array() {
231			return get_object_vars( $this );
232			}
233
234			/**
235			* Getter.
236			*
237			* @since 4.4.0
238			* @access public
239			*
240			* @param string $key Property to get.
241			* @return mixed Property value.
242			*/
243			public function __get( $key ) {
244			switch ( $key ) {
245			case 'data' :
246			$data = new stdClass();
247			$columns = array( 'term_id', 'name', 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description', 'parent', 'count' );
248			foreach ( $columns as $column ) {
249			$data->{$column} = isset( $this->{$column} ) ? $this->{$column} : null;
250			}
251
252			return sanitize_term( $data, $data->taxonomy, 'raw' );
253			break;
			0 ignored issues – show Unused Code introduced 2016-03-16 22:18 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
254			}
255			}
256			}
257

ntwb / wordpress

Push — master ( a7cd2a...eabd6c )

WP_Term::__get() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like