wp/wp-includes/customize/class-wp-customize-date-time-control.php
changeset 7 cf61fcea0001
child 9 177826044cd9
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/wp/wp-includes/customize/class-wp-customize-date-time-control.php	Mon Oct 14 17:39:30 2019 +0200
@@ -0,0 +1,271 @@
+<?php
+/**
+ * Customize API: WP_Customize_Date_Time_Control class
+ *
+ * @package WordPress
+ * @subpackage Customize
+ * @since 4.9.0
+ */
+
+/**
+ * Customize Date Time Control class.
+ *
+ * @since 4.9.0
+ *
+ * @see WP_Customize_Control
+ */
+class WP_Customize_Date_Time_Control extends WP_Customize_Control {
+
+	/**
+	 * Customize control type.
+	 *
+	 * @since 4.9.0
+	 * @var string
+	 */
+	public $type = 'date_time';
+
+	/**
+	 * Minimum Year.
+	 *
+	 * @since 4.9.0
+	 * @var integer
+	 */
+	public $min_year = 1000;
+
+	/**
+	 * Maximum Year.
+	 *
+	 * @since 4.9.0
+	 * @var integer
+	 */
+	public $max_year = 9999;
+
+	/**
+	 * Allow past date, if set to false user can only select future date.
+	 *
+	 * @since 4.9.0
+	 * @var boolean
+	 */
+	public $allow_past_date = true;
+
+	/**
+	 * Whether hours, minutes, and meridian should be shown.
+	 *
+	 * @since 4.9.0
+	 * @var boolean
+	 */
+	public $include_time = true;
+
+	/**
+	 * If set to false the control will appear in 24 hour format,
+	 * the value will still be saved in Y-m-d H:i:s format.
+	 *
+	 * @since 4.9.0
+	 * @var boolean
+	 */
+	public $twelve_hour_format = true;
+
+	/**
+	 * Don't render the control's content - it's rendered with a JS template.
+	 *
+	 * @since 4.9.0
+	 */
+	public function render_content() {}
+
+	/**
+	 * Export data to JS.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public function json() {
+		$data = parent::json();
+
+		$data['maxYear'] = intval( $this->max_year );
+		$data['minYear'] = intval( $this->min_year );
+		$data['allowPastDate'] = (bool) $this->allow_past_date;
+		$data['twelveHourFormat'] = (bool) $this->twelve_hour_format;
+		$data['includeTime'] = (bool) $this->include_time;
+
+		return $data;
+	}
+
+	/**
+	 * Renders a JS template for the content of date time control.
+	 *
+	 * @since 4.9.0
+	 */
+	public function content_template() {
+		$data = array_merge( $this->json(), $this->get_month_choices() );
+		$timezone_info = $this->get_timezone_info();
+
+		$date_format = get_option( 'date_format' );
+		$date_format = preg_replace( '/(?<!\\\\)[Yyo]/', '%1$s', $date_format );
+		$date_format = preg_replace( '/(?<!\\\\)[FmMn]/', '%2$s', $date_format );
+		$date_format = preg_replace( '/(?<!\\\\)[jd]/', '%3$s', $date_format );
+
+		// Fallback to ISO date format if year, month, or day are missing from the date format.
+		if ( 1 !== substr_count( $date_format, '%1$s' ) || 1 !== substr_count( $date_format, '%2$s' ) || 1 !== substr_count( $date_format, '%3$s' ) ) {
+			$date_format = '%1$s-%2$s-%3$s';
+		}
+		?>
+
+		<# _.defaults( data, <?php echo wp_json_encode( $data ); ?> ); #>
+		<# var idPrefix = _.uniqueId( 'el' ) + '-'; #>
+
+		<# if ( data.label ) { #>
+			<span class="customize-control-title">
+				{{ data.label }}
+			</span>
+		<# } #>
+		<div class="customize-control-notifications-container"></div>
+		<# if ( data.description ) { #>
+			<span class="description customize-control-description">{{ data.description }}</span>
+		<# } #>
+		<div class="date-time-fields {{ data.includeTime ? 'includes-time' : '' }}">
+			<fieldset class="day-row">
+				<legend class="title-day {{ ! data.includeTime ? 'screen-reader-text' : '' }}"><?php esc_html_e( 'Date' ); ?></legend>
+				<div class="day-fields clear">
+					<?php ob_start(); ?>
+					<label for="{{ idPrefix }}date-time-month" class="screen-reader-text"><?php esc_html_e( 'Month' ); ?></label>
+					<select id="{{ idPrefix }}date-time-month" class="date-input month" data-component="month">
+						<# _.each( data.month_choices, function( choice ) {
+							if ( _.isObject( choice ) && ! _.isUndefined( choice.text ) && ! _.isUndefined( choice.value ) ) {
+								text = choice.text;
+								value = choice.value;
+							}
+							#>
+							<option value="{{ value }}" >
+								{{ text }}
+							</option>
+						<# } ); #>
+					</select>
+					<?php $month_field = trim( ob_get_clean() ); ?>
+
+					<?php ob_start(); ?>
+					<label for="{{ idPrefix }}date-time-day" class="screen-reader-text"><?php esc_html_e( 'Day' ); ?></label>
+					<input id="{{ idPrefix }}date-time-day" type="number" size="2" autocomplete="off" class="date-input day" data-component="day" min="1" max="31" />
+					<?php $day_field = trim( ob_get_clean() ); ?>
+
+					<?php ob_start(); ?>
+					<label for="{{ idPrefix }}date-time-year" class="screen-reader-text"><?php esc_html_e( 'Year' ); ?></label>
+					<input id="{{ idPrefix }}date-time-year" type="number" size="4" autocomplete="off" class="date-input year" data-component="year" min="{{ data.minYear }}" max="{{ data.maxYear }}">
+					<?php $year_field = trim( ob_get_clean() ); ?>
+
+					<?php printf( $date_format, $year_field, $month_field, $day_field ); ?>
+				</div>
+			</fieldset>
+			<# if ( data.includeTime ) { #>
+				<fieldset class="time-row clear">
+					<legend class="title-time"><?php esc_html_e( 'Time' ); ?></legend>
+					<div class="time-fields clear">
+						<label for="{{ idPrefix }}date-time-hour" class="screen-reader-text"><?php esc_html_e( 'Hour' ); ?></label>
+						<# var maxHour = data.twelveHourFormat ? 12 : 23; #>
+						<# var minHour = data.twelveHourFormat ? 1 : 0; #>
+						<input id="{{ idPrefix }}date-time-hour" type="number" size="2" autocomplete="off" class="date-input hour" data-component="hour" min="{{ minHour }}" max="{{ maxHour }}">
+						:
+						<label for="{{ idPrefix }}date-time-minute" class="screen-reader-text"><?php esc_html_e( 'Minute' ); ?></label>
+						<input id="{{ idPrefix }}date-time-minute" type="number" size="2" autocomplete="off" class="date-input minute" data-component="minute" min="0" max="59">
+						<# if ( data.twelveHourFormat ) { #>
+							<label for="{{ idPrefix }}date-time-meridian" class="screen-reader-text"><?php esc_html_e( 'Meridian' ); ?></label>
+							<select id="{{ idPrefix }}date-time-meridian" class="date-input meridian" data-component="meridian">
+								<option value="am"><?php esc_html_e( 'AM' ); ?></option>
+								<option value="pm"><?php esc_html_e( 'PM' ); ?></option>
+							</select>
+						<# } #>
+						<abbr class="date-timezone" aria-label="<?php esc_attr_e( 'Timezone' ); ?>" title="<?php echo esc_attr( $timezone_info['description'] ); ?>"><?php echo esc_html( $timezone_info['abbr'] ); ?></abbr>
+					</div>
+				</fieldset>
+			<# } #>
+		</div>
+		<?php
+	}
+
+	/**
+	 * Generate options for the month Select.
+	 *
+	 * Based on touch_time().
+	 *
+	 * @since 4.9.0
+	 * @see touch_time()
+	 *
+	 * @return array
+	 */
+	public function get_month_choices() {
+		global $wp_locale;
+		$months = array();
+		for ( $i = 1; $i < 13; $i++ ) {
+			$month_text = $wp_locale->get_month_abbrev( $wp_locale->get_month( $i ) );
+
+			/* translators: 1: month number (01, 02, etc.), 2: month abbreviation */
+			$months[ $i ]['text'] = sprintf( __( '%1$s-%2$s' ), $i, $month_text );
+			$months[ $i ]['value'] = $i;
+		}
+		return array(
+			'month_choices' => $months,
+		);
+	}
+
+	/**
+	 * Get timezone info.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return array abbr and description.
+	 */
+	public function get_timezone_info() {
+		$tz_string = get_option( 'timezone_string' );
+		$timezone_info = array();
+
+		if ( $tz_string ) {
+			try {
+				$tz = new DateTimezone( $tz_string );
+			} catch ( Exception $e ) {
+				$tz = '';
+			}
+
+			if ( $tz ) {
+				$now = new DateTime( 'now', $tz );
+				$formatted_gmt_offset = sprintf( 'UTC%s', $this->format_gmt_offset( $tz->getOffset( $now ) / 3600 ) );
+				$tz_name = str_replace( '_', ' ', $tz->getName() );
+				$timezone_info['abbr'] = $now->format( 'T' );
+
+				/* translators: 1: timezone name, 2: timezone abbreviation, 3: gmt offset  */
+				$timezone_info['description'] = sprintf( __( 'Timezone is %1$s (%2$s), currently %3$s.' ), $tz_name, $timezone_info['abbr'], $formatted_gmt_offset );
+			} else {
+				$timezone_info['description'] = '';
+			}
+		} else {
+			$formatted_gmt_offset = $this->format_gmt_offset( intval( get_option( 'gmt_offset', 0 ) ) );
+			$timezone_info['abbr'] = sprintf( 'UTC%s', $formatted_gmt_offset );
+
+			/* translators: %s: UTC offset  */
+			$timezone_info['description'] = sprintf( __( 'Timezone is %s.' ), $timezone_info['abbr'] );
+		}
+
+		return $timezone_info;
+	}
+
+	/**
+	 * Format GMT Offset.
+	 *
+	 * @since 4.9.0
+	 * @see wp_timezone_choice()
+	 *
+	 * @param float $offset Offset in hours.
+	 * @return string Formatted offset.
+	 */
+	public function format_gmt_offset( $offset ) {
+		if ( 0 <= $offset ) {
+			$formatted_offset = '+' . (string) $offset;
+		} else {
+			$formatted_offset = (string) $offset;
+		}
+		$formatted_offset = str_replace(
+			array( '.25', '.5', '.75' ),
+			array( ':15', ':30', ':45' ),
+			$formatted_offset
+		);
+		return $formatted_offset;
+	}
+}