WordAds_Params - Code Metrics - Inspection of "Merge pull request #7747 from Automattic/cleanup/5..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/improve-api-docs ( 94dfd5 )

unknown

created 2017-09-16 15:16 UTC

WordAds_Params B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	194
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	2

Importance

Changes

Metric	Value
dl	0
loc	194
rs	8.4864
c	0
b	0
f	0
wmc	48
lcom	3
cbo	2

8 Methods

Rating	Name	Size	Complexity
C	__construct()	48	9
A	is_mobile()	3	1
B	is_cloudflare()	16	5
A	is_ios()	3	1
A	get_device()	13	3
D	get_page_type()	25	9
A	is_static_home()	5	3
D	should_show()	29	17

How to fix Complexity

<?php

class WordAds_Params {

	/**
	 * Setup parameters for serving the ads
	 *
	 * @since 4.5.0
	 */
	public function __construct() {
		// WordAds setting => default
		$settings = array(
			'wordads_approved'           => false,
			'wordads_active'             => false,
			'wordads_house'              => true,
			'enable_header_ad'           => false,
			'wordads_second_belowpost'   => true,
			'wordads_display_front_page' => true,
			'wordads_display_post'       => true,
			'wordads_display_page'       => true,
			'wordads_display_archive'    => true,
		);

		// grab settings, or set as default if it doesn't exist
		$this->options = array();
class MyClass { }

$x = new MyClass();
$x->foo = true;
		foreach ( $settings as $setting => $default ) {
			$option = get_option( $setting, null );
			if ( is_null( $option ) ) {
				update_option( $setting, $default, true );
				$option = $default;
			}

			$this->options[$setting] = (bool) $option;
		}

		$host = 'localhost';
		if ( isset( $_SERVER['HTTP_HOST'] ) ) {
			$host = $_SERVER['HTTP_HOST'];
		}

		$this->url = ( is_ssl() ? 'https' : 'http' ) . '://' . $host . $_SERVER['REQUEST_URI'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
		if ( ! ( false === strpos( $this->url, '?' ) ) && ! isset( $_GET['p'] ) ) {
			$this->url = substr( $this->url, 0, strpos( $this->url, '?' ) );
		}

		$this->cloudflare = self::is_cloudflare();
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->blog_id = Jetpack::get_option( 'id', 0 );
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->mobile_device = jetpack_is_mobile( 'any', true );
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->targeting_tags = array(
class MyClass { }

$x = new MyClass();
$x->foo = true;
			'WordAds'   => 1,
			'BlogId'    => Jetpack::is_development_mode() ? 0 : Jetpack_Options::get_option( 'id' ),
			'Domain'    => esc_js( parse_url( home_url(), PHP_URL_HOST ) ),
			'PageURL'   => esc_js( $this->url ),
			'LangId'    => false !== strpos( get_bloginfo( 'language' ), 'en' ) ? 1 : 0, // TODO something else?

			'AdSafe'    => 1, // TODO

		);
	}

	/**
	 * @return boolean true if the user is browsing on a mobile device (iPad not included)
	 *
	 * @since 4.5.0
	 */
	public function is_mobile() {
		return ! empty( $this->mobile_device );
	}

	/**
	 * @return boolean true if site is being served via CloudFlare
	 *
	 * @since 4.5.0
	 */
	public static function is_cloudflare() {
		if ( defined( 'WORDADS_CLOUDFLARE' ) ) {
			return true;
		}
		if ( isset( $_SERVER['HTTP_CF_CONNECTING_IP'] ) ) {
			return true;
		}
		if ( isset( $_SERVER['HTTP_CF_IPCOUNTRY'] ) ) {
			return true;
		}
		if ( isset( $_SERVER['HTTP_CF_VISITOR'] ) ) {
			return true;
		}

		return false;
	}

	/**
	 * @return boolean true if user is browsing in iOS device
	 *
	 * @since 4.5.0
	 */
	public function is_ios() {
		return in_array( $this->get_device(), array( 'ipad', 'iphone', 'ipod' ) );
	}

	/**
	 * Returns the user's device (see user-agent.php) or 'desktop'
	 * @return string user device
	 *
	 * @since 4.5.0
	 */
	public function get_device() {
		global $agent_info;

		if ( ! empty( $this->mobile_device ) ) {
			return $this->mobile_device;
		}

		if ( $agent_info->is_ipad() ) {
			return 'ipad';
		}

		return 'desktop';
	}

	/**
	 * @return string The type of page that is being loaded
	 *
	 * @since 4.5.0
	 */
	public function get_page_type() {
		if ( ! empty( $this->page_type ) ) {
			return $this->page_type;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		}

		if ( self::is_static_home() ) {
			$this->page_type = 'static_home';
		} else if ( is_home() ) {
			$this->page_type = 'home';
		} else if ( is_page() ) {
			$this->page_type = 'page';
		} else if ( is_single() ) {
			$this->page_type = 'post';
		} else if ( is_search() ) {
			$this->page_type = 'search';
		} else if ( is_category() ) {
			$this->page_type = 'category';
		} else if ( is_archive() ) {
			$this->page_type = 'archive';
		} else {
			$this->page_type = 'wtf';
		}

		return $this->page_type;
	}

	/**
	 * Returns true if page is static home
	 * @return boolean true if page is static home
	 *
	 * @since 4.5.0
	 */
	public static function is_static_home() {
		return is_front_page() &&
			'page' == get_option( 'show_on_front' ) &&
			get_option( 'page_on_front' );
	}

	/**
	 * Logic for if we should show an ad
	 *
	 * @since 4.5.0
	 */
	public function should_show() {
		global $wp_query;
		if ( ( is_front_page() || is_home() ) && ! $this->options['wordads_display_front_page'] ) {
			return false;
		}

		if ( is_single() && ! $this->options['wordads_display_post'] ) {
			return false;
		}

		if ( is_page() && ! $this->options['wordads_display_page'] ) {
			return false;
		}

		if ( is_archive() && ! $this->options['wordads_display_archive'] ) {
			return false;
		}

		if ( is_single() || ( is_page() && ! is_home() ) ) {
			return true;
		}

		// TODO this would be a good place for allowing the user to specify

		if ( ( is_home() || is_archive() || is_search() ) && 0 == $wp_query->current_post ) {
			return true;
		}

		return false;
	}
}


1			<?php
2
3			class WordAds_Params {
4
5			/**
6			* Setup parameters for serving the ads
7			*
8			* @since 4.5.0
9			*/
10			public function __construct() {
11			// WordAds setting => default
12			$settings = array(
13			'wordads_approved' => false,
14			'wordads_active' => false,
15			'wordads_house' => true,
16			'enable_header_ad' => false,
17			'wordads_second_belowpost' => true,
18			'wordads_display_front_page' => true,
19			'wordads_display_post' => true,
20			'wordads_display_page' => true,
21			'wordads_display_archive' => true,
22			);
23
24			// grab settings, or set as default if it doesn't exist
25			$this->options = array();
			0 ignored issues – show Bug introduced 2017-09-13 18:41 UTC by Report Bug Copy Issue Report The property `options` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
26			foreach ( $settings as $setting => $default ) {
27			$option = get_option( $setting, null );
28			if ( is_null( $option ) ) {
29			update_option( $setting, $default, true );
30			$option = $default;
31			}
32
33			$this->options[$setting] = (bool) $option;
34			}
35
36			$host = 'localhost';
37			if ( isset( $_SERVER['HTTP_HOST'] ) ) {
38			$host = $_SERVER['HTTP_HOST'];
39			}
40
41			$this->url = ( is_ssl() ? 'https' : 'http' ) . '://' . $host . $_SERVER['REQUEST_URI'];
			0 ignored issues – show Bug introduced 2016-12-14 19:13 UTC by Report Bug Copy Issue Report The property `url` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
42			if ( ! ( false === strpos( $this->url, '?' ) ) && ! isset( $_GET['p'] ) ) {
43			$this->url = substr( $this->url, 0, strpos( $this->url, '?' ) );
44			}
45
46			$this->cloudflare = self::is_cloudflare();
			0 ignored issues – show Bug introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report The property `cloudflare` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
47			$this->blog_id = Jetpack::get_option( 'id', 0 );
			0 ignored issues – show Bug introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report The property `blog_id` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
48			$this->mobile_device = jetpack_is_mobile( 'any', true );
			0 ignored issues – show Bug introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report The property `mobile_device` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
49			$this->targeting_tags = array(
			0 ignored issues – show Bug introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report The property `targeting_tags` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
50			'WordAds' => 1,
51			'BlogId' => Jetpack::is_development_mode() ? 0 : Jetpack_Options::get_option( 'id' ),
52			'Domain' => esc_js( parse_url( home_url(), PHP_URL_HOST ) ),
53			'PageURL' => esc_js( $this->url ),
54			'LangId' => false !== strpos( get_bloginfo( 'language' ), 'en' ) ? 1 : 0, // TODO something else?
			0 ignored issues – show Coding Style Best Practice introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
55			'AdSafe' => 1, // TODO
			0 ignored issues – show Coding Style introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
56			);
57			}
58
59			/**
60			* @return boolean true if the user is browsing on a mobile device (iPad not included)
61			*
62			* @since 4.5.0
63			*/
64			public function is_mobile() {
65			return ! empty( $this->mobile_device );
66			}
67
68			/**
69			* @return boolean true if site is being served via CloudFlare
70			*
71			* @since 4.5.0
72			*/
73			public static function is_cloudflare() {
74			if ( defined( 'WORDADS_CLOUDFLARE' ) ) {
75			return true;
76			}
77			if ( isset( $_SERVER['HTTP_CF_CONNECTING_IP'] ) ) {
78			return true;
79			}
80			if ( isset( $_SERVER['HTTP_CF_IPCOUNTRY'] ) ) {
81			return true;
82			}
83			if ( isset( $_SERVER['HTTP_CF_VISITOR'] ) ) {
84			return true;
85			}
86
87			return false;
88			}
89
90			/**
91			* @return boolean true if user is browsing in iOS device
92			*
93			* @since 4.5.0
94			*/
95			public function is_ios() {
96			return in_array( $this->get_device(), array( 'ipad', 'iphone', 'ipod' ) );
97			}
98
99			/**
100			* Returns the user's device (see user-agent.php) or 'desktop'
101			* @return string user device
102			*
103			* @since 4.5.0
104			*/
105			public function get_device() {
106			global $agent_info;
107
108			if ( ! empty( $this->mobile_device ) ) {
109			return $this->mobile_device;
110			}
111
112			if ( $agent_info->is_ipad() ) {
113			return 'ipad';
114			}
115
116			return 'desktop';
117			}
118
119			/**
120			* @return string The type of page that is being loaded
121			*
122			* @since 4.5.0
123			*/
124			public function get_page_type() {
125			if ( ! empty( $this->page_type ) ) {
126			return $this->page_type;
			0 ignored issues – show Bug introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report The property `page_type` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
127			}
128
129			if ( self::is_static_home() ) {
130			$this->page_type = 'static_home';
131			} else if ( is_home() ) {
132			$this->page_type = 'home';
133			} else if ( is_page() ) {
134			$this->page_type = 'page';
135			} else if ( is_single() ) {
136			$this->page_type = 'post';
137			} else if ( is_search() ) {
138			$this->page_type = 'search';
139			} else if ( is_category() ) {
140			$this->page_type = 'category';
141			} else if ( is_archive() ) {
142			$this->page_type = 'archive';
143			} else {
144			$this->page_type = 'wtf';
145			}
146
147			return $this->page_type;
148			}
149
150			/**
151			* Returns true if page is static home
152			* @return boolean true if page is static home
153			*
154			* @since 4.5.0
155			*/
156			public static function is_static_home() {
157			return is_front_page() &&
158			'page' == get_option( 'show_on_front' ) &&
159			get_option( 'page_on_front' );
160			}
161
162			/**
163			* Logic for if we should show an ad
164			*
165			* @since 4.5.0
166			*/
167			public function should_show() {
168			global $wp_query;
169			if ( ( is_front_page() \|\| is_home() ) && ! $this->options['wordads_display_front_page'] ) {
170			return false;
171			}
172
173			if ( is_single() && ! $this->options['wordads_display_post'] ) {
174			return false;
175			}
176
177			if ( is_page() && ! $this->options['wordads_display_page'] ) {
178			return false;
179			}
180
181			if ( is_archive() && ! $this->options['wordads_display_archive'] ) {
182			return false;
183			}
184
185			if ( is_single() \|\| ( is_page() && ! is_home() ) ) {
186			return true;
187			}
188
189			// TODO this would be a good place for allowing the user to specify
			0 ignored issues – show Coding Style Best Practice introduced 2016-10-12 21:02 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
190			if ( ( is_home() \|\| is_archive() \|\| is_search() ) && 0 == $wp_query->current_post ) {
191			return true;
192			}
193
194			return false;
195			}
196			}
197

Automattic / jetpack

Push — update/improve-api-docs ( 94dfd5 )

WordAds_Params B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like