Completed
Push — trunk ( df6be1...704260 )
by Justin
05:04
created

CMB2_Utils::timezone_string()   B

Complexity

Conditions 5
Paths 8

Size

Total Lines 21
Code Lines 13

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 10
CRAP Score 5.9256

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 21
ccs 10
cts 15
cp 0.6667
rs 8.7624
cc 5
eloc 13
nc 8
nop 0
crap 5.9256
1
<?php
2
/**
3
 * CMB2 Utilities
4
 *
5
 * @since  1.1.0
6
 *
7
 * @category  WordPress_Plugin
8
 * @package   CMB2
9
 * @author    WebDevStudios
10
 * @license   GPL-2.0+
11
 * @link      http://webdevstudios.com
12
 */
13
class CMB2_Utils {
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

You can fix this by adding a namespace to your class:

namespace YourVendor;

class YourClass { }

When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.

Loading history...
14
15
	/**
16
	 * The url which is used to load local resources.
17
	 * @var   string
18
	 * @since 2.0.0
19
	 */
20
	protected $url = '';
21
22
	/**
23
	 * Utility method that attempts to get an attachment's ID by it's url
24
	 * @since  1.0.0
25
	 * @param  string  $img_url Attachment url
26
	 * @return int|false            Attachment ID or false
27
	 */
28 1
	public function image_id_from_url( $img_url ) {
29 1
		$attachment_id = 0;
30 1
		$dir = wp_upload_dir();
31
32
		// Is URL in uploads directory?
33 1
		if ( false === strpos( $img_url, $dir['baseurl'] . '/' ) ) {
34
			return false;
35
		}
36
37 1
		$file = basename( $img_url );
38
39
		$query_args = array(
40 1
			'post_type'   => 'attachment',
41 1
			'post_status' => 'inherit',
42 1
			'fields'      => 'ids',
43
			'meta_query'  => array(
44
				array(
45 1
					'value'   => $file,
46 1
					'compare' => 'LIKE',
47 1
					'key'     => '_wp_attachment_metadata',
48 1
				),
49
			)
50 1
		);
51
52 1
		$query = new WP_Query( $query_args );
53
54 1
		if ( $query->have_posts() ) {
55
56 1
			foreach ( $query->posts as $post_id ) {
57 1
				$meta = wp_get_attachment_metadata( $post_id );
58 1
				$original_file       = basename( $meta['file'] );
59 1
				$cropped_image_files = isset( $meta['sizes'] ) ? wp_list_pluck( $meta['sizes'], 'file' ) : array();
60 1
				if ( $original_file === $file || in_array( $file, $cropped_image_files ) ) {
61 1
					$attachment_id = $post_id;
62 1
					break;
63
				}
64 1
			}
65
66 1
		}
67
68 1
		return 0 === $attachment_id ? false : $attachment_id;
69
	}
70
71
	/**
72
	 * Utility method that returns time string offset by timezone
73
	 * @since  1.0.0
74
	 * @param  string $tzstring Time string
75
	 * @return string           Offset time string
76
	 */
77 1
	public function timezone_offset( $tzstring ) {
78 1
		$tz_offset = 0;
79
80 1
		if ( ! empty( $tzstring ) && is_string( $tzstring ) ) {
81 1
			if ( 'UTC' === substr( $tzstring, 0, 3 ) ) {
82
				$tzstring = str_replace( array( ':15', ':30', ':45' ), array( '.25', '.5', '.75' ), $tzstring );
83
				return intval( floatval( substr( $tzstring, 3 ) ) * HOUR_IN_SECONDS );
84
			}
85
86
			try {
87 1
				$date_time_zone_selected = new DateTimeZone( $tzstring );
88 1
				$tz_offset = timezone_offset_get( $date_time_zone_selected, date_create() );
89 1
			} catch ( Exception $e ) {
90
				$this->log_if_debug( __METHOD__, __LINE__, $e->getMessage() );
91
			}
92
93 1
		}
94
95 1
		return $tz_offset;
96
	}
97
98
	/**
99
	 * Utility method that returns a timezone string representing the default timezone for the site.
100
	 *
101
	 * Roughly copied from WordPress, as get_option('timezone_string') will return
102
	 * an empty string if no value has been set on the options page.
103
	 * A timezone string is required by the wp_timezone_choice() used by the
104
	 * select_timezone field.
105
	 *
106
	 * @since  1.0.0
107
	 * @return string Timezone string
108
	 */
109 1
	public function timezone_string() {
110 1
		$current_offset = get_option( 'gmt_offset' );
111 1
		$tzstring       = get_option( 'timezone_string' );
112
113
		// Remove old Etc mappings. Fallback to gmt_offset.
114 1
		if ( false !== strpos( $tzstring, 'Etc/GMT' ) ) {
115
			$tzstring = '';
116
		}
117
118 1
		if ( empty( $tzstring ) ) { // Create a UTC+- zone if no timezone string exists
119 1
			if ( 0 == $current_offset ) {
120 1
				$tzstring = 'UTC+0';
121 1
			} elseif ( $current_offset < 0 ) {
122
				$tzstring = 'UTC' . $current_offset;
123
			} else {
124
				$tzstring = 'UTC+' . $current_offset;
125
			}
126 1
		}
127
128 1
		return $tzstring;
129
	}
130
131
	/**
132
	 * Returns a timestamp, first checking if value already is a timestamp.
133
	 * @since  2.0.0
134
	 * @param  string|int $string Possible timestamp string
135
	 * @return int   	            Time stamp
136
	 */
137 5
	public function make_valid_time_stamp( $string ) {
138 5
		if ( ! $string ) {
139
			return 0;
140
		}
141
142 5
		return $this->is_valid_time_stamp( $string )
143 5
			? (int) $string :
144 5
			strtotime( (string) $string );
145
	}
146
147
	/**
148
	 * Determine if a value is a valid timestamp
149
	 * @since  2.0.0
150
	 * @param  mixed  $timestamp Value to check
151
	 * @return boolean           Whether value is a valid timestamp
152
	 */
153 5
	public function is_valid_time_stamp( $timestamp ) {
154 5
		return (string) (int) $timestamp === (string) $timestamp
155 5
			&& $timestamp <= PHP_INT_MAX
156 5
			&& $timestamp >= ~PHP_INT_MAX;
157
	}
158
159
	/**
160
	 * Checks if a value is 'empty'. Still accepts 0.
161
	 * @since  2.0.0
162
	 * @param  mixed $value Value to check
163
	 * @return bool         True or false
164
	 */
165 51
	public function isempty( $value ) {
166 51
		return null === $value || '' === $value || false === $value;
167
	}
168
169
	/**
170
	 * Insert a single array item inside another array at a set position
171
	 * @since  2.0.2
172
	 * @param  array &$array   Array to modify. Is passed by reference, and no return is needed.
173
	 * @param  array $new      New array to insert
174
	 * @param  int   $position Position in the main array to insert the new array
175
	 */
176 2
	public function array_insert( &$array, $new, $position ) {
177 2
		$before = array_slice( $array, 0, $position - 1 );
178 2
		$after  = array_diff_key( $array, $before );
179 2
		$array  = array_merge( $before, $new, $after );
180 2
	}
181
182
	/**
183
	 * Defines the url which is used to load local resources.
184
	 * This may need to be filtered for local Window installations.
185
	 * If resources do not load, please check the wiki for details.
186
	 * @since  1.0.1
187
	 * @return string URL to CMB2 resources
188
	 */
189 2
	public function url( $path = '' ) {
190 2
		if ( $this->url ) {
191 1
			return $this->url . $path;
192
		}
193
194 1
		$cmb2_url = self::get_url_from_dir( cmb2_dir() );
195
196
		/**
197
		 * Filter the CMB location url
198
		 *
199
		 * @param string $cmb2_url Currently registered url
200
		 */
201 1
		$this->url = trailingslashit( apply_filters( 'cmb2_meta_box_url', $cmb2_url, CMB2_VERSION ) );
202
203 1
		return $this->url . $path;
204
	}
205
206
	/**
207
	 * Converts a system path to a URL
208
	 * @since  2.2.2
209
	 * @param  string $dir Directory path to convert.
210
	 * @return string      Converted URL.
211
	 */
212 1
	public static function get_url_from_dir( $dir ) {
213 1
		if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) {
214
			// Windows
215
			$content_dir = str_replace( '/', DIRECTORY_SEPARATOR, WP_CONTENT_DIR );
216
			$content_url = str_replace( $content_dir, WP_CONTENT_URL, $dir );
217
			$url = str_replace( DIRECTORY_SEPARATOR, '/', $content_url );
218
219
		} else {
220 1
			$url = str_replace(
221 1
				array( WP_CONTENT_DIR, WP_PLUGIN_DIR ),
222 1
				array( WP_CONTENT_URL, WP_PLUGIN_URL ),
223
				$dir
224 1
			);
225
		}
226
227 1
		return set_url_scheme( $url );
228
	}
229
230
	/**
231
	 * Get timestamp from text date
232
	 * @since  2.2.0
233
	 * @param  string $value       Date value
234
	 * @param  string $date_format Expected date format
235
	 * @return mixed               Unix timestamp representing the date.
236
	 */
237
	public function get_timestamp_from_value( $value, $date_format ) {
238
		$date_object = date_create_from_format( $date_format, $value );
239
		return $date_object ? $date_object->setTime( 0, 0, 0 )->getTimeStamp() : strtotime( $value );
240
	}
241
242
	/**
243
	 * Takes a php date() format string and returns a string formatted to suit for the date/time pickers
244
	 * It will work with only with the following subset ot date() options:
245
	 *
246
	 *  d, j, z, m, n, y, and Y.
247
	 *
248
	 * A slight effort is made to deal with escaped characters.
249
	 *
250
	 * Other options are ignored, because they would either bring compatibility problems between PHP and JS, or
251
	 * bring even more translation troubles.
252
	 *
253
	 * @since 2.2.0
254
	 * @param string $format php date format
255
	 * @return string reformatted string
256
	 */
257 5
	public function php_to_js_dateformat( $format ) {
258
259
		// order is relevant here, since the replacement will be done sequentially.
260
		$supported_options = array(
261 5
			'd' => 'dd',  // Day, leading 0
262 5
			'j' => 'd',   // Day, no 0
263 5
			'z' => 'o',   // Day of the year, no leading zeroes,
264
			// 'D' => 'D',   // Day name short, not sure how it'll work with translations
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
265
			// 'l' => 'DD',  // Day name full, idem before
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
266 5
			'm' => 'mm',  // Month of the year, leading 0
267 5
			'n' => 'm',   // Month of the year, no leading 0
268
			// 'M' => 'M',   // Month, Short name
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
269
			// 'F' => 'MM',  // Month, full name,
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
270 5
			'y' => 'y',   // Year, two digit
271 5
			'Y' => 'yy',  // Year, full
272 5
			'H' => 'HH',  // Hour with leading 0 (24 hour)
273 5
			'G' => 'H',   // Hour with no leading 0 (24 hour)
274 5
			'h' => 'hh',  // Hour with leading 0 (12 hour)
275 5
			'g' => 'h',   // Hour with no leading 0 (12 hour),
276 5
			'i' => 'mm',  // Minute with leading 0,
277 5
			's' => 'ss',  // Second with leading 0,
278 5
			'a' => 'tt',  // am/pm
279
			'A' => 'TT'   // AM/PM
280 5
		);
281
282 5
		foreach ( $supported_options as $php => $js ) {
283
			// replaces every instance of a supported option, but skips escaped characters
284 5
			$format = preg_replace( "~(?<!\\\\)$php~", $js, $format );
285 5
		}
286
287 5
		$format = preg_replace_callback( '~(?:\\\.)+~', array( $this, 'wrap_escaped_chars' ), $format );
288
289 5
		return $format;
290
	}
291
292
	/**
293
	 * Helper function for CMB_Utils->php_to_js_dateformat, because php 5.2 was retarded.
294
	 * @since  2.2.0
295
	 * @param  $value Value to wrap/escape
296
	 * @return string Modified value
297
	 */
298 4
	public function wrap_escaped_chars( $value ) {
299 4
		return "&#39;" . str_replace( '\\', '', $value[0] ) . "&#39;";
300
	}
301
302
	/**
303
	 * Send to debug.log if WP_DEBUG is defined and true
304
	 *
305
	 * @since  2.2.0
306
	 *
307
	 * @param  string  $function Function name
308
	 * @param  int     $line     Line number
309
	 * @param  mixed   $msg      Message to output
310
	 * @param  mixed   $debug    Variable to print_r
311
	 */
312
	public function log_if_debug( $function, $line, $msg, $debug = null ) {
313
		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
314
			error_log( "In $function, $line:" . print_r( $msg, true ) . ( $debug ? print_r( $debug, true ) : '' ) );
315
		}
316
	}
317
318
	/**
319
	 * Determine a file's extension
320
	 * @since  1.0.0
321
	 * @param  string       $file File url
322
	 * @return string|false       File extension or false
323
	 */
324 4
	public function get_file_ext( $file ) {
325 4
		$parsed = @parse_url( $file, PHP_URL_PATH );
326 4
		return $parsed ? strtolower( pathinfo( $parsed, PATHINFO_EXTENSION ) ) : false;
327
	}
328
329
	/**
330
	 * Get the file name from a url
331
	 * @since  2.0.0
332
	 * @param  string $value File url or path
333
	 * @return string        File name
334
	 */
335 3
	public function get_file_name_from_path( $value ) {
336 3
		$parts = explode( '/', $value );
337 3
		return is_array( $parts ) ? end( $parts ) : $value;
338
	}
339
}
340