<!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>[59477] trunk: Interactivity API: Support length property on strings and arrays on the server</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/59477">59477</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/59477","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>gziolo</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-12-02 08:08:34 +0000 (Mon, 02 Dec 2024)</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'>Interactivity API: Support length property on strings and arrays on the server
The Interactivity API tries to align client and server rendering so that the behavior is the same. Adds missing handling for `.length` to directives processing on the server on strings and numeric arrays which is inherently supported through JavaScript language on the client.
Props jonsurrell, gziolo, luisherranz.
Fixes <a href="https://core.trac.wordpress.org/ticket/62582">#62582</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesinteractivityapiclasswpinteractivityapiphp">trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php</a></li>
<li><a href="#trunktestsphpunittestsinteractivityapiwpInteractivityAPIphp">trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesinteractivityapiclasswpinteractivityapiphp"></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/interactivity-api/class-wp-interactivity-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php 2024-12-02 05:42:44 UTC (rev 59476)
+++ trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php 2024-12-02 08:08:34 UTC (rev 59477)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -579,6 +579,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $path_segments = explode( '.', $path );
</span><span class="cx" style="display: block; padding: 0 10px"> $current = $store;
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $path_segments as $path_segment ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Special case for numeric arrays and strings. Add length
+ * property mimicking JavaScript behavior.
+ *
+ * @since 6.8.0
+ */
+ if ( 'length' === $path_segment ) {
+ if ( is_array( $current ) && array_is_list( $current ) ) {
+ $current = count( $current );
+ break;
+ }
+
+ if ( is_string( $current ) ) {
+ /*
+ * Differences in encoding between PHP strings and
+ * JavaScript mean that it's complicated to calculate
+ * the string length JavaScript would see from PHP.
+ * `strlen` is a reasonable approximation.
+ *
+ * Users that desire a more precise length likely have
+ * more precise needs than "bytelength" and should
+ * implement their own length calculation in derived
+ * state taking into account encoding and their desired
+ * output (codepoints, graphemes, bytes, etc.).
+ */
+ $current = strlen( $current );
+ break;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ( is_array( $current ) || $current instanceof ArrayAccess ) && isset( $current[ $path_segment ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $current = $current[ $path_segment ];
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_object( $current ) && isset( $current->$path_segment ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsinteractivityapiwpInteractivityAPIphp"></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/interactivity-api/wpInteractivityAPI.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php 2024-12-02 05:42:44 UTC (rev 59476)
+++ trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php 2024-12-02 08:08:34 UTC (rev 59477)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1541,4 +1541,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $element = $this->interactivity->get_element();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( $element );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Verify behavior of .length directive access.
+ *
+ * @ticket 62582
+ *
+ * @covers ::process_directives
+ *
+ * @dataProvider data_length_directives
+ *
+ * @param mixed $value The property value.
+ * @param string $expected The expected property length as a string,
+ * or "" if no length is expected.
+ */
+ public function test_process_directives_string_array_length( $value, string $expected ) {
+ $this->interactivity->state(
+ 'myPlugin',
+ array( 'prop' => $value )
+ );
+ $html = '<div data-wp-text="myPlugin::state.prop.length"></div>';
+ $processed_html = $this->interactivity->process_directives( $html );
+ $processor = new WP_HTML_Tag_Processor( $processed_html );
+ $processor->next_tag( 'DIV' );
+ $processor->next_token();
+ $this->assertSame( $expected, $processor->get_modifiable_text() );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public static function data_length_directives(): array {
+ return array(
+ 'numeric array' => array( array( 'a', 'b', 'c' ), '3' ),
+ 'empty array' => array( array(), '0' ),
+ 'string' => array( 'abc', '3' ),
+ 'empty string' => array( '', '0' ),
+
+ // Failure cases resulting in empty string.
+ 'non-numeric array' => array( array( 'a' => 'a' ), '' ),
+ 'object' => array( new stdClass(), '' ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>