Changeset 49063

Timestamp:

09/27/2020 07:01:18 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Support the multipleOf JSON Schema keyword.

Props yakimun.
Fixes #51022.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-validation.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-test-controller.php (modified) (1 diff)

trunk/src/wp-includes/rest-api.php

@@ -1553 +1553 @@
  *              Validate required properties.
  * @since 5.6.0 Support the "minProperties" and "maxProperties" keywords for objects.
+ *              Support the "multipleOf" keyword for numbers and integers.
  *
  * @param mixed  $value The value to validate.
@@ -1692 +1693 @@
     }
 
-    if ( in_array( $args['type'], array( 'integer', 'number' ), true ) && ! is_numeric( $value ) ) {
-        /* translators: 1: Parameter, 2: Type name. */
-        return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, $args['type'] ) );
+    if ( in_array( $args['type'], array( 'integer', 'number' ), true ) ) {
+        if ( ! is_numeric( $value ) ) {
+            /* translators: 1: Parameter, 2: Type name. */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, $args['type'] ) );
+        }
+
+        if ( isset( $args['multipleOf'] ) && fmod( $value, $args['multipleOf'] ) !== 0.0 ) {
+            /* translators: 1: Parameter, 2: Multiplier. */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must be a multiple of %2$s.' ), $param, $args['multipleOf'] ) );
+        }
     }
 
@@ -2299 +2307 @@
         'exclusiveMinimum',
         'exclusiveMaximum',
+        'multipleOf',
         'minLength',
         'maxLength',

trunk/tests/phpunit/tests/rest-api/rest-controller.php

@@ -282 +282 @@
         }
 
-        foreach ( array( 'minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum' ) as $property ) {
+        foreach ( array( 'multipleOf', 'minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum' ) as $property ) {
             $this->assertArrayHasKey( $property, $args['someinteger'] );
         }

trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php

@@ -434 +434 @@
         $this->assertWPError( $error );
         $this->assertSame( 'param must be between 10 (inclusive) and 20 (inclusive)', $error->get_error_message() );
+    }
+
+    /**
+     * @ticket 51022
+     *
+     * @dataProvider data_multiply_of
+     *
+     * @param int|float $value
+     * @param int|float $divisor
+     * @param bool      $expected
+     */
+    public function test_numeric_multiple_of( $value, $divisor, $expected ) {
+        $schema = array(
+            'type'       => 'number',
+            'multipleOf' => $divisor,
+        );
+
+        $result = rest_validate_value_from_schema( $value, $schema );
+
+        if ( $expected ) {
+            $this->assertTrue( $result );
+        } else {
+            $this->assertWPError( $result );
+        }
+    }
+
+    public function data_multiply_of() {
+        return array(
+            array( 0, 2, true ),
+            array( 4, 2, true ),
+            array( 3, 1.5, true ),
+            array( 2.4, 1.2, true ),
+            array( 1, 2, false ),
+            array( 2, 1.5, false ),
+            array( 2.1, 1.5, false ),
+        );
     }
 

trunk/tests/phpunit/tests/rest-api/rest-test-controller.php

@@ -47 +47 @@
                 'someinteger'    => array(
                     'type'             => 'integer',
+                    'multipleOf'       => 10,
                     'minimum'          => 100,
                     'maximum'          => 200,