<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[47923] trunk: REST API: Support the (min|max)Items JSON Schema keywords.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/47923">47923</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/47923","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-07 22:40:16 +0000 (Sun, 07 Jun 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Support the (min|max)Items JSON Schema keywords.
A future commit will add support for the uniqueItems keyword.
Props sorenbronsted.
See <a href="https://core.trac.wordpress.org/ticket/48821">#48821</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestcontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemavalidationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiresttestcontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-test-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2020-06-07 09:22:07 UTC (rev 47922)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2020-06-07 22:40:16 UTC (rev 47923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -643,6 +643,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'minLength',
</span><span class="cx" style="display: block; padding: 0 10px"> 'maxLength',
</span><span class="cx" style="display: block; padding: 0 10px"> 'pattern',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'minItems',
+ 'maxItems',
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $schema_properties as $field_id => $params ) {
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2020-06-07 09:22:07 UTC (rev 47922)
+++ trunk/src/wp-includes/rest-api.php 2020-06-07 22:40:16 UTC (rev 47923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1250,6 +1250,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 Add the "uuid" and "hex-color" formats.
</span><span class="cx" style="display: block; padding: 0 10px"> * Support the "minLength", "maxLength" and "pattern" keywords for strings.
</span><span class="cx" style="display: block; padding: 0 10px"> * Validate required properties.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Support the "minItems" and "maxItems" keywords for arrays.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value The value to validate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Schema array to use for validation.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1287,6 +1288,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $is_valid;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( isset( $args['minItems'] ) && count( $value ) < $args['minItems'] ) {
+ /* translators: 1: Parameter, 2: number. */
+ return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at least %2$s items.' ), $param, number_format_i18n( $args['minItems'] ) ) );
+ }
+
+ if ( isset( $args['maxItems'] ) && count( $value ) > $args['maxItems'] ) {
+ /* translators: 1: Parameter, 2: number. */
+ return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at most %2$s items.' ), $param, number_format_i18n( $args['maxItems'] ) ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'object' === $args['type'] ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestcontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-controller.php 2020-06-07 09:22:07 UTC (rev 47922)
+++ trunk/tests/phpunit/tests/rest-api/rest-controller.php 2020-06-07 22:40:16 UTC (rev 47923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -265,6 +265,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'items', $args['somearray'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array( 'minItems', 'maxItems' ) as $property ) {
+ $this->assertArrayHasKey( $property, $args['somearray'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( array( 'properties', 'additionalProperties' ) as $property ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( $property, $args['someobject'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestschemavalidationphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2020-06-07 09:22:07 UTC (rev 47922)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2020-06-07 22:40:16 UTC (rev 47923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -766,4 +766,40 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( rest_validate_value_from_schema( 'â', $schema ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( rest_validate_value_from_schema( 'ââ', $schema ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 48821
+ */
+ public function test_array_min_items() {
+ $schema = array(
+ 'type' => 'array',
+ 'minItems' => 1,
+ 'items' => array(
+ 'type' => 'number',
+ ),
+ );
+
+ $this->assertTrue( rest_validate_value_from_schema( array( 1, 2 ), $schema ) );
+ $this->assertTrue( rest_validate_value_from_schema( array( 1 ), $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( array(), $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( '', $schema ) );
+ }
+
+ /**
+ * @ticket 48821
+ */
+ public function test_array_max_items() {
+ $schema = array(
+ 'type' => 'array',
+ 'maxItems' => 2,
+ 'items' => array(
+ 'type' => 'number',
+ ),
+ );
+
+ $this->assertTrue( rest_validate_value_from_schema( array( 1 ), $schema ) );
+ $this->assertTrue( rest_validate_value_from_schema( array( 1, 2 ), $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( array( 1, 2, 3 ), $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( 'foobar', $schema ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiresttestcontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-test-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-test-controller.php 2020-06-07 09:22:07 UTC (rev 47922)
+++ trunk/tests/phpunit/tests/rest-api/rest-test-controller.php 2020-06-07 22:40:16 UTC (rev 47923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -101,11 +101,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => 'a',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'somearray' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'array',
- 'items' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'array',
+ 'items' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'context' => array( 'view' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'minItems' => 1,
+ 'maxItems' => 10,
+ 'context' => array( 'view' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'someobject' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span></span></pre>
</div>
</div>
</body>
</html>