CMB2_Utils::log_if_debug() - Code Metrics - Inspection of "Use plugins_url when/if applicable. Fixes #27, Fix..." - WebDevStudios/CMB2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — trunk ( 90dfb1...7ce277 )

by Justin

created 2016-04-20 14:54 UTC

CMB2_Utils::log_if_debug() A

↳ Parent: CMB2_Utils

Complexity

Conditions	4
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Metric	Value
dl	0
loc	5
rs	9.2
ccs	0
cts	0
cp	0
cc	4
eloc	3
nc	2
nop	4
crap	20

<?php
/**
 * CMB2 Utilities
 *
 * @since  1.1.0
 *
 * @category  WordPress_Plugin
 * @package   CMB2
 * @author    WebDevStudios
 * @license   GPL-2.0+
 * @link      http://webdevstudios.com
 */
class CMB2_Utils {
namespace YourVendor;

class YourClass { }

	/**
	 * The url which is used to load local resources.
	 * @var   string
	 * @since 2.0.0
	 */
	protected $url = '';

	/**
	 * Utility method that attempts to get an attachment's ID by it's url
	 * @since  1.0.0
	 * @param  string  $img_url Attachment url
	 * @return int|false            Attachment ID or false
	 */
	public function image_id_from_url( $img_url ) {
		$attachment_id = 0;
		$dir = wp_upload_dir();

		// Is URL in uploads directory?
		if ( false === strpos( $img_url, $dir['baseurl'] . '/' ) ) {
			return false;
		}

		$file = basename( $img_url );

		$query_args = array(
			'post_type'   => 'attachment',
			'post_status' => 'inherit',
			'fields'      => 'ids',
			'meta_query'  => array(
				array(
					'value'   => $file,
					'compare' => 'LIKE',
					'key'     => '_wp_attachment_metadata',
				),
			)
		);

		$query = new WP_Query( $query_args );

		if ( $query->have_posts() ) {

			foreach ( $query->posts as $post_id ) {
				$meta = wp_get_attachment_metadata( $post_id );
				$original_file       = basename( $meta['file'] );
				$cropped_image_files = isset( $meta['sizes'] ) ? wp_list_pluck( $meta['sizes'], 'file' ) : array();
				if ( $original_file === $file || in_array( $file, $cropped_image_files ) ) {
					$attachment_id = $post_id;
					break;
				}
			}

		}

		return 0 === $attachment_id ? false : $attachment_id;
	}

	/**
	 * Utility method that returns time string offset by timezone
	 * @since  1.0.0
	 * @param  string $tzstring Time string
	 * @return string           Offset time string
	 */
	public function timezone_offset( $tzstring ) {
		$tz_offset = 0;

		if ( ! empty( $tzstring ) && is_string( $tzstring ) ) {
			if ( 'UTC' === substr( $tzstring, 0, 3 ) ) {
				$tzstring = str_replace( array( ':15', ':30', ':45' ), array( '.25', '.5', '.75' ), $tzstring );
				return intval( floatval( substr( $tzstring, 3 ) ) * HOUR_IN_SECONDS );
			}

			try {
				$date_time_zone_selected = new DateTimeZone( $tzstring );
				$tz_offset = timezone_offset_get( $date_time_zone_selected, date_create() );
			} catch ( Exception $e ) {
				$this->log_if_debug( __METHOD__, __LINE__, $e->getMessage() );
			}

		}

		return $tz_offset;
	}

	/**
	 * Utility method that returns a timezone string representing the default timezone for the site.
	 *
	 * Roughly copied from WordPress, as get_option('timezone_string') will return
	 * an empty string if no value has been set on the options page.
	 * A timezone string is required by the wp_timezone_choice() used by the
	 * select_timezone field.
	 *
	 * @since  1.0.0
	 * @return string Timezone string
	 */
	public function timezone_string() {
		$current_offset = get_option( 'gmt_offset' );
		$tzstring       = get_option( 'timezone_string' );

		// Remove old Etc mappings. Fallback to gmt_offset.
		if ( false !== strpos( $tzstring, 'Etc/GMT' ) ) {
			$tzstring = '';
		}

		if ( empty( $tzstring ) ) { // Create a UTC+- zone if no timezone string exists
			if ( 0 == $current_offset ) {
				$tzstring = 'UTC+0';
			} elseif ( $current_offset < 0 ) {
				$tzstring = 'UTC' . $current_offset;
			} else {
				$tzstring = 'UTC+' . $current_offset;
			}
		}

		return $tzstring;
	}

	/**
	 * Returns a timestamp, first checking if value already is a timestamp.
	 * @since  2.0.0
	 * @param  string|int $string Possible timestamp string
	 * @return int   	            Time stamp
	 */
	public function make_valid_time_stamp( $string ) {
		if ( ! $string ) {
			return 0;
		}

		return $this->is_valid_time_stamp( $string )
			? (int) $string :
			strtotime( (string) $string );
	}

	/**
	 * Determine if a value is a valid timestamp
	 * @since  2.0.0
	 * @param  mixed  $timestamp Value to check
	 * @return boolean           Whether value is a valid timestamp
	 */
	public function is_valid_time_stamp( $timestamp ) {
		return (string) (int) $timestamp === (string) $timestamp
			&& $timestamp <= PHP_INT_MAX
			&& $timestamp >= ~PHP_INT_MAX;
	}

	/**
	 * Checks if a value is 'empty'. Still accepts 0.
	 * @since  2.0.0
	 * @param  mixed $value Value to check
	 * @return bool         True or false
	 */
	public function isempty( $value ) {
		return null === $value || '' === $value || false === $value;
	}

	/**
	 * Insert a single array item inside another array at a set position
	 * @since  2.0.2
	 * @param  array &$array   Array to modify. Is passed by reference, and no return is needed.
	 * @param  array $new      New array to insert
	 * @param  int   $position Position in the main array to insert the new array
	 */
	public function array_insert( &$array, $new, $position ) {
		$before = array_slice( $array, 0, $position - 1 );
		$after  = array_diff_key( $array, $before );
		$array  = array_merge( $before, $new, $after );
	}

	/**
	 * Defines the url which is used to load local resources.
	 * This may need to be filtered for local Window installations.
	 * If resources do not load, please check the wiki for details.
	 * @since  1.0.1
	 * @return string URL to CMB2 resources
	 */
	public function url( $path = '' ) {
		if ( $this->url ) {
			return $this->url . $path;
		}

		$cmb2_url = self::get_url_from_dir( cmb2_dir() );

		/**
		 * Filter the CMB location url
		 *
		 * @param string $cmb2_url Currently registered url
		 */
		$this->url = trailingslashit( apply_filters( 'cmb2_meta_box_url', $cmb2_url, CMB2_VERSION ) );

		return $this->url . $path;
	}

	/**
	 * Converts a system path to a URL
	 * @since  2.2.2
	 * @param  string $dir Directory path to convert.
	 * @return string      Converted URL.
	 */
	public static function get_url_from_dir( $dir ) {
		$dir = wp_normalize_path( $dir );

		// Let's test if We are in the plugins or mu-plugins dir.
		$test_dir = trailingslashit( $dir ) . 'unneeded.php';
		if (
			0 === strpos( $test_dir, wp_normalize_path( WPMU_PLUGIN_DIR ) )
			|| 0 === strpos( $test_dir, wp_normalize_path( WP_PLUGIN_URL ) )
		) {
			// Ok, then use plugins_url, as it is more reliable.
			return trailingslashit( plugins_url( '', $test_dir ) );
		}

		if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) {
			// Windows
			$content_dir = str_replace( '/', DIRECTORY_SEPARATOR, WP_CONTENT_DIR );
			$content_url = str_replace( $content_dir, WP_CONTENT_URL, $dir );
			$url = str_replace( DIRECTORY_SEPARATOR, '/', $content_url );

		} else {
			if ( false !== strpos( $dir, WP_CONTENT_DIR ) ) {
				$url = str_replace(
					array( WP_CONTENT_DIR, WP_PLUGIN_DIR ),
					array( WP_CONTENT_URL, WP_PLUGIN_URL ),
					$dir
				);
			} else {
				// Check to see if it's in the root directory
				$to_trim = str_replace( ABSPATH, '', WP_CONTENT_DIR );
				$url = str_replace(
					array( ABSPATH ),
					array( str_replace( $to_trim, '', WP_CONTENT_URL ) ),
					$dir
				);
			}
		}

		return set_url_scheme( $url );
	}

	/**
	 * Get timestamp from text date
	 * @since  2.2.0
	 * @param  string $value       Date value
	 * @param  string $date_format Expected date format
	 * @return mixed               Unix timestamp representing the date.
	 */
	public function get_timestamp_from_value( $value, $date_format ) {
		$date_object = date_create_from_format( $date_format, $value );
		return $date_object ? $date_object->setTime( 0, 0, 0 )->getTimeStamp() : strtotime( $value );
	}

	/**
	 * Takes a php date() format string and returns a string formatted to suit for the date/time pickers
	 * It will work with only with the following subset ot date() options:
	 *
	 *  d, j, z, m, n, y, and Y.
	 *
	 * A slight effort is made to deal with escaped characters.
	 *
	 * Other options are ignored, because they would either bring compatibility problems between PHP and JS, or
	 * bring even more translation troubles.
	 *
	 * @since 2.2.0
	 * @param string $format php date format
	 * @return string reformatted string
	 */
	public function php_to_js_dateformat( $format ) {

		// order is relevant here, since the replacement will be done sequentially.
		$supported_options = array(
			'd' => 'dd',  // Day, leading 0
			'j' => 'd',   // Day, no 0
			'z' => 'o',   // Day of the year, no leading zeroes,
			// 'D' => 'D',   // Day name short, not sure how it'll work with translations

			// 'l' => 'DD',  // Day name full, idem before

			'm' => 'mm',  // Month of the year, leading 0
			'n' => 'm',   // Month of the year, no leading 0
			// 'M' => 'M',   // Month, Short name

			// 'F' => 'MM',  // Month, full name,

			'y' => 'y',   // Year, two digit
			'Y' => 'yy',  // Year, full
			'H' => 'HH',  // Hour with leading 0 (24 hour)
			'G' => 'H',   // Hour with no leading 0 (24 hour)
			'h' => 'hh',  // Hour with leading 0 (12 hour)
			'g' => 'h',   // Hour with no leading 0 (12 hour),
			'i' => 'mm',  // Minute with leading 0,
			's' => 'ss',  // Second with leading 0,
			'a' => 'tt',  // am/pm
			'A' => 'TT'   // AM/PM
		);

		foreach ( $supported_options as $php => $js ) {
			// replaces every instance of a supported option, but skips escaped characters
			$format = preg_replace( "~(?<!\\\\)$php~", $js, $format );
		}

		$format = preg_replace_callback( '~(?:\\\.)+~', array( $this, 'wrap_escaped_chars' ), $format );

		return $format;
	}

	/**
	 * Helper function for CMB_Utils->php_to_js_dateformat, because php 5.2 was retarded.
	 * @since  2.2.0
	 * @param  $value Value to wrap/escape
	 * @return string Modified value
	 */
	public function wrap_escaped_chars( $value ) {
		return "&#39;" . str_replace( '\\', '', $value[0] ) . "&#39;";
	}

	/**
	 * Send to debug.log if WP_DEBUG is defined and true
	 *
	 * @since  2.2.0
	 *
	 * @param  string  $function Function name
	 * @param  int     $line     Line number
	 * @param  mixed   $msg      Message to output
	 * @param  mixed   $debug    Variable to print_r
	 */
	public function log_if_debug( $function, $line, $msg, $debug = null ) {
		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
			error_log( "In $function, $line:" . print_r( $msg, true ) . ( $debug ? print_r( $debug, true ) : '' ) );
		}
	}

	/**
	 * Determine a file's extension
	 * @since  1.0.0
	 * @param  string       $file File url
	 * @return string|false       File extension or false
	 */
	public function get_file_ext( $file ) {
		$parsed = @parse_url( $file, PHP_URL_PATH );
		return $parsed ? strtolower( pathinfo( $parsed, PATHINFO_EXTENSION ) ) : false;
	}

	/**
	 * Get the file name from a url
	 * @since  2.0.0
	 * @param  string $value File url or path
	 * @return string        File name
	 */
	public function get_file_name_from_path( $value ) {
		$parts = explode( '/', $value );
		return is_array( $parts ) ? end( $parts ) : $value;
	}
}


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 2015-11-24 04:05 UTC by Report Bug Copy Issue Report 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	1	/**
23	1	* Utility method that attempts to get an attachment's ID by it's url
24		* @since 1.0.0
25	1	* @param string $img_url Attachment url
26		* @return int\|false Attachment ID or false
27	1	*/
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	1
37	1	$file = basename( $img_url );
38
39		$query_args = array(
40		'post_type' => 'attachment',
41		'post_status' => 'inherit',
42		'fields' => 'ids',
43		'meta_query' => array(
44		array(
45		'value' => $file,
46		'compare' => 'LIKE',
47		'key' => '_wp_attachment_metadata',
48		),
49		)
50	2	);
51	2
52	1	$query = new WP_Query( $query_args );
53	1
54	1	if ( $query->have_posts() ) {
55
56		foreach ( $query->posts as $post_id ) {
57		$meta = wp_get_attachment_metadata( $post_id );
58		$original_file = basename( $meta['file'] );
59		$cropped_image_files = isset( $meta['sizes'] ) ? wp_list_pluck( $meta['sizes'], 'file' ) : array();
60		if ( $original_file === $file \|\| in_array( $file, $cropped_image_files ) ) {
61		$attachment_id = $post_id;
62		break;
63	1	}
64		}
65
66		}
67
68		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	2	public function timezone_offset( $tzstring ) {
78	2	$tz_offset = 0;
79	2
80		if ( ! empty( $tzstring ) && is_string( $tzstring ) ) {
81	2	if ( 'UTC' === substr( $tzstring, 0, 3 ) ) {
82	2	$tzstring = str_replace( array( ':15', ':30', ':45' ), array( '.25', '.5', '.75' ), $tzstring );
83	2	return intval( floatval( substr( $tzstring, 3 ) ) * HOUR_IN_SECONDS );
84	2	}
85
86		try {
87		$date_time_zone_selected = new DateTimeZone( $tzstring );
88		$tz_offset = timezone_offset_get( $date_time_zone_selected, date_create() );
89	2	} catch ( Exception $e ) {
90		$this->log_if_debug( __METHOD__, __LINE__, $e->getMessage() );
91	2	}
92
93		}
94
95		return $tz_offset;
96		}
97
98		/**
99		* Utility method that returns a timezone string representing the default timezone for the site.
100	5	*
101	5	* 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	5	*
106	5	* @since 1.0.0
107	5	* @return string Timezone string
108		*/
109		public function timezone_string() {
110		$current_offset = get_option( 'gmt_offset' );
111		$tzstring = get_option( 'timezone_string' );
112
113		// Remove old Etc mappings. Fallback to gmt_offset.
114		if ( false !== strpos( $tzstring, 'Etc/GMT' ) ) {
115		$tzstring = '';
116	5	}
117	5
118	5	if ( empty( $tzstring ) ) { // Create a UTC+- zone if no timezone string exists
119	5	if ( 0 == $current_offset ) {
120	5	$tzstring = 'UTC+0';
121		} elseif ( $current_offset < 0 ) {
122		$tzstring = 'UTC' . $current_offset;
123		} else {
124		$tzstring = 'UTC+' . $current_offset;
125		}
126		}
127
128		return $tzstring;
129		}
130	2
131	2	/**
132	1	* 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	1	* @return int Time stamp
136		*/
137		public function make_valid_time_stamp( $string ) {
138		if ( ! $string ) {
139		return 0;
140		}
141
142	1	return $this->is_valid_time_stamp( $string )
143	1	? (int) $string :
144	1	strtotime( (string) $string );
145	1	}
146	1
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		public function is_valid_time_stamp( $timestamp ) {
154	1	return (string) (int) $timestamp === (string) $timestamp
155		&& $timestamp <= PHP_INT_MAX
156	1	&& $timestamp >= ~PHP_INT_MAX;
157		}
158
159		/**
160	1	* 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		public function isempty( $value ) {
166		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		public function array_insert( &$array, $new, $position ) {
177		$before = array_slice( $array, 0, $position - 1 );
178		$after = array_diff_key( $array, $before );
179		$array = array_merge( $before, $new, $after );
180		}
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		public function url( $path = '' ) {
190		if ( $this->url ) {
191		return $this->url . $path;
192		}
193
194		$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		$this->url = trailingslashit( apply_filters( 'cmb2_meta_box_url', $cmb2_url, CMB2_VERSION ) );
202
203		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		public static function get_url_from_dir( $dir ) {
213		$dir = wp_normalize_path( $dir );
214
215		// Let's test if We are in the plugins or mu-plugins dir.
216		$test_dir = trailingslashit( $dir ) . 'unneeded.php';
217		if (
218		0 === strpos( $test_dir, wp_normalize_path( WPMU_PLUGIN_DIR ) )
219		\|\| 0 === strpos( $test_dir, wp_normalize_path( WP_PLUGIN_URL ) )
220		) {
221		// Ok, then use plugins_url, as it is more reliable.
222		return trailingslashit( plugins_url( '', $test_dir ) );
223		}
224
225		if ( 'WIN' === strtoupper( substr( PHP_OS, 0, 3 ) ) ) {
226		// Windows
227		$content_dir = str_replace( '/', DIRECTORY_SEPARATOR, WP_CONTENT_DIR );
228		$content_url = str_replace( $content_dir, WP_CONTENT_URL, $dir );
229		$url = str_replace( DIRECTORY_SEPARATOR, '/', $content_url );
230
231		} else {
232		if ( false !== strpos( $dir, WP_CONTENT_DIR ) ) {
233		$url = str_replace(
234		array( WP_CONTENT_DIR, WP_PLUGIN_DIR ),
235		array( WP_CONTENT_URL, WP_PLUGIN_URL ),
236		$dir
237		);
238		} else {
239		// Check to see if it's in the root directory
240		$to_trim = str_replace( ABSPATH, '', WP_CONTENT_DIR );
241		$url = str_replace(
242		array( ABSPATH ),
243		array( str_replace( $to_trim, '', WP_CONTENT_URL ) ),
244		$dir
245		);
246		}
247		}
248
249		return set_url_scheme( $url );
250		}
251
252		/**
253		* Get timestamp from text date
254		* @since 2.2.0
255		* @param string $value Date value
256		* @param string $date_format Expected date format
257		* @return mixed Unix timestamp representing the date.
258		*/
259		public function get_timestamp_from_value( $value, $date_format ) {
260		$date_object = date_create_from_format( $date_format, $value );
261		return $date_object ? $date_object->setTime( 0, 0, 0 )->getTimeStamp() : strtotime( $value );
262		}
263
264		/**
265		* Takes a php date() format string and returns a string formatted to suit for the date/time pickers
266		* It will work with only with the following subset ot date() options:
267		*
268		* d, j, z, m, n, y, and Y.
269		*
270		* A slight effort is made to deal with escaped characters.
271		*
272		* Other options are ignored, because they would either bring compatibility problems between PHP and JS, or
273		* bring even more translation troubles.
274		*
275		* @since 2.2.0
276		* @param string $format php date format
277		* @return string reformatted string
278		*/
279		public function php_to_js_dateformat( $format ) {
280
281		// order is relevant here, since the replacement will be done sequentially.
282		$supported_options = array(
283		'd' => 'dd', // Day, leading 0
284		'j' => 'd', // Day, no 0
285		'z' => 'o', // Day of the year, no leading zeroes,
286		// 'D' => 'D', // Day name short, not sure how it'll work with translations
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-06 02:23 UTC by Report Bug Copy Issue Report `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...
287		// 'l' => 'DD', // Day name full, idem before
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-06 02:23 UTC by Report Bug Copy Issue Report `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...
288		'm' => 'mm', // Month of the year, leading 0
289		'n' => 'm', // Month of the year, no leading 0
290		// 'M' => 'M', // Month, Short name
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-06 02:23 UTC by Report Bug Copy Issue Report `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...
291		// 'F' => 'MM', // Month, full name,
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-06 02:23 UTC by Report Bug Copy Issue Report `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...
292		'y' => 'y', // Year, two digit
293		'Y' => 'yy', // Year, full
294		'H' => 'HH', // Hour with leading 0 (24 hour)
295		'G' => 'H', // Hour with no leading 0 (24 hour)
296		'h' => 'hh', // Hour with leading 0 (12 hour)
297		'g' => 'h', // Hour with no leading 0 (12 hour),
298		'i' => 'mm', // Minute with leading 0,
299		's' => 'ss', // Second with leading 0,
300		'a' => 'tt', // am/pm
301		'A' => 'TT' // AM/PM
302		);
303
304		foreach ( $supported_options as $php => $js ) {
305		// replaces every instance of a supported option, but skips escaped characters
306		$format = preg_replace( "~(?<!\\\\)$php~", $js, $format );
307		}
308
309		$format = preg_replace_callback( '~(?:\\\.)+~', array( $this, 'wrap_escaped_chars' ), $format );
310
311		return $format;
312		}
313
314		/**
315		* Helper function for CMB_Utils->php_to_js_dateformat, because php 5.2 was retarded.
316		* @since 2.2.0
317		* @param $value Value to wrap/escape
318		* @return string Modified value
319		*/
320		public function wrap_escaped_chars( $value ) {
321		return "'" . str_replace( '\\', '', $value[0] ) . "'";
322		}
323
324		/**
325		* Send to debug.log if WP_DEBUG is defined and true
326		*
327		* @since 2.2.0
328		*
329		* @param string $function Function name
330		* @param int $line Line number
331		* @param mixed $msg Message to output
332		* @param mixed $debug Variable to print_r
333		*/
334		public function log_if_debug( $function, $line, $msg, $debug = null ) {
335		if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
336		error_log( "In $function, $line:" . print_r( $msg, true ) . ( $debug ? print_r( $debug, true ) : '' ) );
337		}
338		}
339
340		/**
341		* Determine a file's extension
342		* @since 1.0.0
343		* @param string $file File url
344		* @return string\|false File extension or false
345		*/
346		public function get_file_ext( $file ) {
347		$parsed = @parse_url( $file, PHP_URL_PATH );
348		return $parsed ? strtolower( pathinfo( $parsed, PATHINFO_EXTENSION ) ) : false;
349		}
350
351		/**
352		* Get the file name from a url
353		* @since 2.0.0
354		* @param string $value File url or path
355		* @return string File name
356		*/
357		public function get_file_name_from_path( $value ) {
358		$parts = explode( '/', $value );
359		return is_array( $parts ) ? end( $parts ) : $value;
360		}
361		}
362

WebDevStudios / CMB2

Push — trunk ( 90dfb1...7ce277 )

CMB2_Utils::log_if_debug() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like