/vendor/cmb2/includes/CMB2_Utils.php
PHP | 301 lines | 142 code | 37 blank | 122 comment | 21 complexity | 6163860921a2994c0b5be9190870e64c MD5 | raw file
- <?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 {
- /**
- * 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' );
- 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;
- }
- 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, cmb2_dir() );
- $cmb2_url = str_replace( DIRECTORY_SEPARATOR, '/', $content_url );
- } else {
- $cmb2_url = str_replace(
- array( WP_CONTENT_DIR, WP_PLUGIN_DIR ),
- array( WP_CONTENT_URL, WP_PLUGIN_URL ),
- cmb2_dir()
- );
- }
- /**
- * Filter the CMB location url
- *
- * @param string $cmb2_url Currently registered url
- */
- $this->url = trailingslashit( apply_filters( 'cmb2_meta_box_url', set_url_scheme( $cmb2_url ), CMB2_VERSION ) );
- return $this->url . $path;
- }
- /**
- * 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 "'" . str_replace( '\\', '', $value[0] ) . "'";
- }
- /**
- * 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 ) : '' ) );
- }
- }
- }