<?php
/**
* @package Pods\Fields
*/
class PodsField_DateTime extends PodsField {
/**
* Field Type Group
*
* @var string
* @since 2.0
*/
public static $group = 'Date / Time';
/**
* Field Type Identifier
*
* @var string
* @since 2.0
*/
public static $type = 'datetime';
/**
* Field Type Label
*
* @var string
* @since 2.0
*/
public static $label = 'Date / Time';
/**
* Field Type Preparation
*
* @var string
* @since 2.0
*/
public static $prepare = '%s';
/**
* Do things like register/enqueue scripts and stylesheets
*
* @since 2.0
*/
public function __construct () {
}
/**
* Add options and set defaults to
*
* @return array
*
* @since 2.0
*/
public function options () {
$options = array(
self::$type . '_repeatable' => array(
'label' => __( 'Repeatable Field', 'pods' ),
'default' => 0,
'type' => 'boolean',
'help' => __( 'Making a field repeatable will add controls next to the field which allows users to Add/Remove/Reorder additional values. These values are saved in the database as an array, so searching and filtering by them may require further adjustments".', 'pods' ),
'boolean_yes_label' => '',
'dependency' => true,
'developer_mode' => true
),
self::$type . '_format' => array(
'label' => __( 'Date Format', 'pods' ),
'default' => 'mdy',
'type' => 'pick',
'data' => array(
'mdy' => date_i18n( 'm/d/Y' ),
'mdy_dash' => date_i18n( 'm-d-Y' ),
'mdy_dot' => date_i18n( 'm.d.Y' ),
'ymd_slash' => date_i18n( 'Y/m/d' ),
'ymd_dash' => date_i18n( 'Y-m-d' ),
'ymd_dot' => date_i18n( 'Y.m.d' ),
'fjy' => date_i18n( 'F j, Y' ),
'fjsy' => date_i18n( 'F jS, Y' ),
'c' => date_i18n( 'c' )
),
'dependency' => true
),
self::$type . '_time_type' => array(
'label' => __( 'Time Format Type', 'pods' ),
'excludes-on' => array( self::$type . '_format' => 'c' ),
'default' => '12',
'type' => 'pick',
'data' => array(
'12' => __( '12 hour', 'pods' ),
'24' => __( '24 hour', 'pods' )
),
'dependency' => true
),
self::$type . '_time_format' => array(
'label' => __( 'Time Format', 'pods' ),
'depends-on' => array( self::$type . '_time_type' => '12' ),
'excludes-on' => array( self::$type . '_format' => 'c' ),
'default' => 'h_mma',
'type' => 'pick',
'data' => array(
'h_mm_A' => date_i18n( 'g:i A' ),
'h_mm_ss_A' => date_i18n( 'g:i:s A' ),
'hh_mm_A' => date_i18n( 'h:i A' ),
'hh_mm_ss_A' => date_i18n( 'h:i:s A' ),
'h_mma' => date_i18n( 'g:ia' ),
'hh_mma' => date_i18n( 'h:ia' ),
'h_mm' => date_i18n( 'g:i' ),
'h_mm_ss' => date_i18n( 'g:i:s' ),
'hh_mm' => date_i18n( 'h:i' ),
'hh_mm_ss' => date_i18n( 'h:i:s' )
)
),
self::$type . '_time_format_24' => array(
'label' => __( 'Time Format', 'pods' ),
'depends-on' => array( self::$type . '_time_type' => '24' ),
'default' => 'hh_mm',
'type' => 'pick',
'data' => array(
'hh_mm' => date_i18n( 'H:i' ),
'hh_mm_ss' => date_i18n( 'H:i:s' )
)
),
self::$type . '_allow_empty' => array(
'label' => __( 'Allow empty value?', 'pods' ),
'default' => 1,
'type' => 'boolean'
),
self::$type . '_html5' => array(
'label' => __( 'Enable HTML5 Input Field?', 'pods' ),
'default' => apply_filters( 'pods_form_ui_field_html5', 0, self::$type ),
'type' => 'boolean'
)
);
// Check if PHP DateTime::createFromFormat exists for additional supported formats
if ( method_exists( 'DateTime', 'createFromFormat' ) || apply_filters( 'pods_form_ui_field_datetime_custom_formatter', false ) ) {
$options[ self::$type . '_format' ][ 'data' ] = array_merge(
$options[ self::$type . '_format' ][ 'data' ],
array(
'dmy' => date_i18n( 'd/m/Y' ),
'dmy_dash' => date_i18n( 'd-m-Y' ),
'dmy_dot' => date_i18n( 'd.m.Y' ),
'dMy' => date_i18n( 'd/M/Y' ),
'dMy_dash' => date_i18n( 'd-M-Y' )
)
);
}
return $options;
}
/**
* Define the current field's schema for DB table storage
*
* @param array $options
*
* @return array
* @since 2.0
*/
public function schema ( $options = null ) {
$schema = 'DATETIME NOT NULL default "0000-00-00 00:00:00"';
return $schema;
}
/**
* Change the way the value of the field is displayed with Pods::get
*
* @param mixed $value
* @param string $name
* @param array $options
* @param array $pod
* @param int $id
*
* @return mixed|null|string
* @since 2.0
*/
public function display ( $value = null, $name = null, $options = null, $pod = null, $id = null ) {
$format = $this->format( $options );
if ( !empty( $value ) && !in_array( $value, array( '0000-00-00', '0000-00-00 00:00:00', '00:00:00' ) ) ) {
$date = $this->createFromFormat( 'Y-m-d H:i:s', (string) $value );
$date_local = $this->createFromFormat( $format, (string) $value );
if ( false !== $date )
$value = $date->format( $format );
elseif ( false !== $date_local )
$value = $date_local->format( $format );
else
$value = date_i18n( $format, strtotime( (string) $value ) );
}
elseif ( 0 == pods_var( self::$type . '_allow_empty', $options, 1 ) )
$value = date_i18n( $format );
else
$value = '';
return $value;
}
/**
* Customize output of the form field
*
* @param string $name
* @param mixed $value
* @param array $options
* @param array $pod
* @param int $id
*
* @since 2.0
*/
public function input ( $name, $value = null, $options = null, $pod = null, $id = null ) {
$options = (array) $options;
$form_field_type = PodsForm::$field_type;
if ( is_array( $value ) )
$value = implode( ' ', $value );
// Format Value
$value = $this->display( $value, $name, $options, null, $pod, $id );
pods_view( PODS_DIR . 'ui/fields/datetime.php', compact( array_keys( get_defined_vars() ) ) );
}
/**
* Change the value or perform actions after validation but before saving to the DB
*
* @param mixed $value
* @param int $id
* @param string $name
* @param array $options
* @param array $fields
* @param array $pod
* @param object $params
*
* @return mixed|string
* @since 2.0
*/
public function pre_save ( $value, $id = null, $name = null, $options = null, $fields = null, $pod = null, $params = null ) {
$format = $this->format( $options );
if ( !empty( $value ) && ( 0 == pods_var( self::$type . '_allow_empty', $options, 1 ) || !in_array( $value, array( '0000-00-00', '0000-00-00 00:00:00', '00:00:00' ) ) ) )
$value = $this->convert_date( $value, 'Y-m-d H:i:s', $format );
elseif ( 1 == pods_var( self::$type . '_allow_empty', $options, 1 ) )
$value = '0000-00-00 00:00:00';
else
$value = current_time( 'mysql' );
return $value;
}
/**
* Customize the Pods UI manage table column output
*
* @param int $id
* @param mixed $value
* @param string $name
* @param array $options
* @param array $fields
* @param array $pod
*
* @return mixed|null|string
* @since 2.0
*/
public function ui ( $id, $value, $name = null, $options = null, $fields = null, $pod = null ) {
$value = $this->display( $value, $name, $options, $pod, $id );
if ( 1 == pods_var( self::$type . '_allow_empty', $options, 1 ) && ( empty( $value ) || in_array( $value, array( '0000-00-00', '0000-00-00 00:00:00', '00:00:00' ) ) ) )
$value = false;
return $value;
}
/**
* Build date/time format string based on options
*
* @param $options
*
* @return string
* @since 2.0
*/
public function format ( $options ) {
$date_format = array(
'mdy' => 'm/d/Y',
'mdy_dash' => 'm-d-Y',
'mdy_dot' => 'm.d.Y',
'dmy' => 'd/m/Y',
'dmy_dash' => 'd-m-Y',
'dmy_dot' => 'd.m.Y',
'ymd_slash' => 'Y/m/d',
'ymd_dash' => 'Y-m-d',
'ymd_dot' => 'Y.m.d',
'dMy' => 'd/M/Y',
'dMy_dash' => 'd-M-Y',
'fjy' => 'F j, Y',
'fjsy' => 'F jS, Y',
'c' => 'c'
);
$time_format = array(
'h_mm_A' => 'g:i A',
'h_mm_ss_A' => 'g:i:s A',
'hh_mm_A' => 'h:i A',
'hh_mm_ss_A' => 'h:i:s A',
'h_mma' => 'g:ia',
'hh_mma' => 'h:ia',
'h_mm' => 'g:i',
'h_mm_ss' => 'g:i:s',
'hh_mm' => 'h:i',
'hh_mm_ss' => 'h:i:s'
);
$format_value = pods_var( self::$type . '_format', $options, 'ymd_dash', null, true );
$format = $date_format[ $format_value ];
if ( 'c' != $format_value ) {
if ( 12 == pods_var( self::$type . '_time_type', $options ) )
$format .= ' ' . $time_format[ pods_var( self::$type . '_time_format', $options, 'hh_mm', null, true ) ];
else
$format .= ' ' . str_replace( array( 'h:', 'g:' ), 'H:', $time_format[ pods_var( self::$type . '_time_format', $options, 'hh_mm', null, true ) ] );
}
return $format;
}
/**
* @param $format
* @param $date
*
* @return DateTime
*/
public function createFromFormat ( $format, $date ) {
if ( method_exists( 'DateTime', 'createFromFormat' ) ) {
$datetimezone = new DateTimeZone( timezone_name_from_abbr( '', get_option( 'gmt_offset' ) * 60 * 60, 0 ) );
$datetime = DateTime::createFromFormat( $format, (string) $date, $datetimezone );
}
else
$datetime = new DateTime( date_i18n( 'Y-m-d H:i:s', strtotime( (string) $date ) ) );
return apply_filters( 'pods_form_ui_field_datetime_formatter', $datetime, $format, $date );
}
/**
* Convert a date from one format to another
*
* @param $value
* @param $new_format
* @param string $original_format
*
* @return string
*/
public function convert_date ( $value, $new_format, $original_format = 'Y-m-d H:i:s' ) {
if ( !empty( $value ) && !in_array( $value, array( '0000-00-00', '0000-00-00 00:00:00', '00:00:00' ) ) ) {
$date = $this->createFromFormat( $original_format, (string) $value );
if ( false !== $date )
$value = $date->format( $new_format );
else
$value = date_i18n( $new_format, strtotime( (string) $value ) );
}
else
$value = date_i18n( $new_format );
return $value;
}
}