Completed
Push — jetpack-fusion-mock-files ( e51750...3b1561 )
by
unknown
13:31
created

WordAds_Params::get_device()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 13
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 7
nc 3
nop 0
dl 0
loc 13
rs 9.4285
c 0
b 0
f 0
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 by
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 by
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 by
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 by
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 by
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 by
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 by
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 by
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 by
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
	 * @return int The page type code for ipw config
152
	 *
153
	 * @since 5.6.0
154
	 */
155
	public function get_page_type_ipw() {
156
		if ( ! empty( $this->page_type_ipw ) ) {
0 ignored issues
show
Bug introduced by
The property page_type_ipw does not seem to exist. Did you mean page_type?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
157
			return $this->page_type_ipw;
0 ignored issues
show
Bug introduced by
The property page_type_ipw does not seem to exist. Did you mean page_type?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
158
		}
159
160
		$page_type_ipw = 6;
161
		if ( self::is_static_home() || is_home() || is_front_page() ) {
162
			$page_type_ipw = 0;
163
		} else if ( is_page() ) {
164
			$page_type_ipw = 2;
165
		} else if ( is_singular() ) {
166
			$page_type_ipw = 1;
167
		} else if ( is_search() ) {
168
			$page_type_ipw = 4;
169
		} else if ( is_category() || is_tag() || is_archive() || is_author() ) {
170
			$page_type_ipw = 3;
171
		} else if ( is_404() ) {
172
			$page_type_ipw = 5;
173
		}
174
175
		$this->page_type_ipw = $page_type_ipw;
0 ignored issues
show
Bug introduced by
The property page_type_ipw does not seem to exist. Did you mean page_type?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
176
		return $page_type_ipw;
177
	}
178
179
	/**
180
	 * Returns true if page is static home
181
	 * @return boolean true if page is static home
182
	 *
183
	 * @since 4.5.0
184
	 */
185
	public static function is_static_home() {
186
		return is_front_page() &&
187
			'page' == get_option( 'show_on_front' ) &&
188
			get_option( 'page_on_front' );
189
	}
190
191
	/**
192
	 * Logic for if we should show an ad
193
	 *
194
	 * @since 4.5.0
195
	 */
196
	public function should_show() {
197
		global $wp_query;
198
		if ( ( is_front_page() || is_home() ) && ! $this->options['wordads_display_front_page'] ) {
199
			return false;
200
		}
201
202
		if ( is_single() && ! $this->options['wordads_display_post'] ) {
203
			return false;
204
		}
205
206
		if ( is_page() && ! $this->options['wordads_display_page'] ) {
207
			return false;
208
		}
209
210
		if ( is_archive() && ! $this->options['wordads_display_archive'] ) {
211
			return false;
212
		}
213
214
		if ( is_single() || ( is_page() && ! is_home() ) ) {
215
			return true;
216
		}
217
218
		// TODO this would be a good place for allowing the user to specify
0 ignored issues
show
Coding Style Best Practice introduced by
Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.
Loading history...
219
		if ( ( is_home() || is_archive() || is_search() ) && 0 == $wp_query->current_post ) {
220
			return true;
221
		}
222
223
		return false;
224
	}
225
}
226