Changeset 30142

Timestamp:

11/01/2014 03:23:15 AM (10 years ago)

Author:

boonebgorges

Message:

Introduced dayofweek_iso time param for WP_Date_Query.

The initial dayofweek param sets day 1 to Sunday. This is out of step with
ISO standards, which calls Monday day 1. To maintain backward compatibility
with the existing parameter, we introduce the new dayofweek_iso for the
new, more compliant param.

Props mboynes.
Fixes #28063.

Location:

trunk

Files:

• src/wp-includes/date.php (modified) (5 diffs)
• tests/phpunit/tests/date/query.php (modified) (1 diff)
• tests/phpunit/tests/query/dateQuery.php (modified) (1 diff)

trunk/src/wp-includes/date.php

@@ -61 +61 @@
      * @var array
      */
-    public $time_keys = array( 'after', 'before', 'year', 'month', 'monthnum', 'week', 'w', 'dayofyear', 'day', 'dayofweek', 'hour', 'minute', 'second' );
+    public $time_keys = array( 'after', 'before', 'year', 'month', 'monthnum', 'week', 'w', 'dayofyear', 'day', 'dayofweek', 'dayofweek_iso', 'hour', 'minute', 'second' );
 
     /**
@@ -68 +68 @@
      * @since 3.7.0
      * @since 4.0.0 The $inclusive logic was updated to include all times within the date range.
+     * @since 4.1.0 Introduced 'dayofweek_iso' time type parameter.
      * @access public
      *
@@ -117 +118 @@
      *             @type int          $dayofyear Optional. The day number of the year. Default empty. Accepts numbers 1-366.
      *             @type int          $day       Optional. The day of the month. Default empty. Accepts numbers 1-31.
-     *             @type int          $dayofweek Optional. The day number of the week. Default empty. Accepts numbers 1-7.
+     *             @type int          $dayofweek Optional. The day number of the week. Default empty. Accepts numbers 1-7 (1 is Sunday).
+     *             @type int          $dayofweek_iso Optional. The day number of the week (ISO). Default empty.
+     *                       Accepts numbers 1-7 (1 is Monday).
      *             @type int          $hour      Optional. The hour of the day. Default empty. Accepts numbers 0-23.
      *             @type int          $minute    Optional. The minute of the hour. Default empty. Accepts numbers 0-60.
@@ -310 +313 @@
         // Days per week.
         $min_max_checks['dayofweek'] = array(
+            'min' => 1,
+            'max' => 7
+        );
+
+        // Days per week.
+        $min_max_checks['dayofweek_iso'] = array(
             'min' => 1,
             'max' => 7
@@ -728 +737 @@
             $where_parts[] = "DAYOFWEEK( $column ) $compare $value";
 
+        if ( isset( $query['dayofweek_iso'] ) && $value = $this->build_value( $compare, $query['dayofweek_iso'] ) )
+            $where_parts[] = "WEEKDAY( $column ) + 1 $compare $value";
+
         if ( isset( $query['hour'] ) || isset( $query['minute'] ) || isset( $query['second'] ) ) {
             // Avoid notices.

trunk/tests/phpunit/tests/date/query.php

@@ -926 +926 @@
 
     /**
+     * @ticket 28063
+     * @expectedIncorrectUsage WP_Date_Query
+     */
+    public function test_validate_date_values_day_of_week_iso() {
+        // Valid values.
+        $days_of_week = range( 1, 7 );
+        foreach ( $days_of_week as $day_of_week ) {
+            $this->assertTrue( $this->q->validate_date_values( array( 'dayofweek_iso' => $day_of_week ) ) );
+        }
+
+        // Invalid values.
+        $days_of_week = array( -1, 0, 8 );
+        foreach ( $days_of_week as $day_of_week ) {
+            $this->assertFalse( $this->q->validate_date_values( array( 'dayofweek_iso' => $day_of_week ) ) );
+        }
+    }
+
+    /**
      * @ticket 25834
      * @expectedIncorrectUsage WP_Date_Query

trunk/tests/phpunit/tests/query/dateQuery.php

@@ -629 +629 @@
                 array(
                     'dayofweek' => 3,
+                ),
+            ),
+        ) );
+
+        $this->assertEquals( array( $p1 ), wp_list_pluck( $posts, 'ID' ) );
+    }
+
+    /**
+     * @ticket 28063
+     */
+    public function test_date_query_dayofweek_iso() {
+        $p1 = $this->factory->post->create( array( 'post_date' => '2014-10-31 10:42:29', ) );
+        $p2 = $this->factory->post->create( array( 'post_date' => '2014-10-30 10:42:29', ) );
+
+        $posts = $this->_get_query_result( array(
+            'date_query' => array(
+                array(
+                    'dayofweek_iso' => 5,
                 ),
             ),