1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
<?php
namespace AutomateWoo;
use AutomateWoo\Fields\Select;
use AutomateWoo\Fields\Text;
defined( 'ABSPATH' ) || exit;
/**
* Class Variable_Abstract_Datetime
*
* @package AutomateWoo
*/
class Variable_Abstract_Datetime extends Variable {
/**
* Shared description prop for datetime variables.
*
* @var string
*/
public $_desc_format_tip; // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore
/**
* Load admin details.
*/
public function load_admin_details() {
$this->_desc_format_tip = $this->get_description_custom_date_formatting_tip();
$this->add_parameter_field( $this->get_format_parameter_field() );
$this->add_parameter_field( $this->get_custom_format_parameter_field() );
$this->add_parameter_field( $this->get_modify_parameter_field() );
}
/**
* Get the PHP date format from the variable's format parameter.
*
* @since 4.5
*
* @param string $format
*
* @return string
*/
protected function get_date_format_from_format_param( $format ) {
switch ( $format ) {
case 'mysql':
return Format::MYSQL;
case 'site':
return wc_date_format();
case 'custom':
return '';
}
// Allow all other date formats through for backwards compatibility.
return $format;
}
/**
* Get options for the date format select parameter.
*
* @since 4.5
*
* @return array
*/
protected function get_date_format_options() {
$options = apply_filters(
'automatewoo/variables/date_format_options',
[
/* translators: %2$s: example date */
'mysql' => __( 'MySQL datetime - %2$s', 'automatewoo' ),
/* translators: %2$s: example date */
'site' => __( 'Site setting - %2$s', 'automatewoo' ),
'Y-m-d' => false,
'm/d/Y' => false,
'd/m/Y' => false,
/* translators: %2$s: example timestamp */
'U' => __( 'Unix timestamp - %2$s', 'automatewoo' ),
'custom' => _x( 'Custom', 'custom date format option', 'automatewoo' ),
],
$this
);
return $options;
}
/**
* Get the date format value for display in the admin area.
*
* @param string $format_name
* @param string $format_value
*
* @return string
*/
protected function get_date_format_option_displayed_value( $format_name, $format_value ) {
$now = aw_normalize_date( 'now' );
$example_date = $now->format_i18n( $this->get_date_format_from_format_param( $format_name ) );
// Set default format
if ( $format_value === false ) {
/* translators: %1$s: format name, %2$s: example date */
$format_value = _x( '%1$s - %2$s', 'date format option', 'automatewoo' );
}
return sprintf( $format_value, $format_name, $example_date );
}
/**
* Formats a datetime variable.
*
* Dates should be passed in the site's timezone.
* WC_DateTime objects will maintain their specified timezone.
*
* @param \WC_DateTime|DateTime|string $input
* @param array $parameters [modify, format]
* @param bool $is_gmt
*
* @return string
*/
public function format_datetime( $input, $parameters, $is_gmt = false ): string {
if ( ! $input ) {
return '';
}
// \WC_DateTime objects will be converted to GMT by aw_normalize_date()
if ( $input instanceof \WC_DateTime ) {
$is_gmt = true;
}
$date = aw_normalize_date( $input );
if ( ! $date ) {
return '';
}
if ( $is_gmt ) {
$date->convert_to_site_time();
}
if ( empty( $parameters['format'] ) ) {
// Blank value meant MYSQL format pre version 4.5
$format = Format::MYSQL;
} elseif ( $parameters['format'] === 'custom' ) {
$format = $parameters['custom-format'];
} else {
$format = $this->get_date_format_from_format_param( $parameters['format'] );
}
if ( ! empty( $parameters['modify'] ) ) {
$date->modify( $parameters['modify'] );
}
return $date->format_i18n( $format );
}
/**
* Get date format parameter field.
*
* @since 5.4.0
*
* @return Select
*/
protected function get_format_parameter_field(): Select {
$options = $this->get_date_format_options();
foreach ( $options as $format_name => &$format_value ) {
$format_value = $this->get_date_format_option_displayed_value( $format_name, $format_value );
}
return ( new Select( false ) )
->set_name( 'format' )
->set_description( __( 'Choose the format that the date will be displayed in. The default is MySQL datetime format.', 'automatewoo' ) )
->set_required( true )
->set_options( $options );
}
/**
* Get custom date format parameter field.
*
* @since 5.4.0
*
* @return Text
*/
protected function get_custom_format_parameter_field(): Text {
$field = ( new Text() )
->set_name( 'custom-format' )
->set_description( __( "Set a format according to the documentation link in the variable's description.", 'automatewoo' ) )
->set_required( true );
$field->meta = [ 'show' => 'format=custom' ];
return $field;
}
/**
* Get date modify parameter field.
*
* @since 5.4.0
*
* @return Text
*/
protected function get_modify_parameter_field(): Text {
return ( new Text() )
->set_name( 'modify' )
->set_description( __( 'Optional parameter to modify the value of the datetime. Uses the PHP strtotime() function.', 'automatewoo' ) )
->set_placeholder( __( 'e.g. +2 months, -1 day, +6 hours', 'automatewoo' ) );
}
/**
* @since 5.4.0
*
* @return string
*/
protected function get_description_custom_date_formatting_tip(): string {
return sprintf(
/* translators: %1$s: opening link tag, %2$s: closing link tag */
__( 'To set a custom date or time format please refer to the %1$sWordPress documentation%2$s.', 'automatewoo' ),
'<a href="https://wordpress.org/support/article/formatting-date-and-time/" target="_blank">',
'</a>'
);
}
}
|