Changeset 57179 for trunk/src/wp-includes/html-api/class-wp-html-attribute-token.php

Timestamp:

12/10/2023 01:17:29 PM (2 years ago)

Author:

zieladam

Message:

HTML API: Track spans of text with (offset, length) instead of (start, end).

Updates the internal representation of the text span coordinates. The mixture of (offset, length) and (start, end) coordinates becomes confusing, this commit replaces it with a (offset, length) pair. There should be no functional or behavioral changes in this patch. For the internal helper classes this patch introduces breaking changes, but those classes are marked private and should not be used outside of the HTML API itself.

Props dmsnell.
Fixes #59993.

File:

• trunk/src/wp-includes/html-api/class-wp-html-attribute-token.php (modified) (9 diffs)

trunk/src/wp-includes/html-api/class-wp-html-attribute-token.php

@@ -16 +16 @@
  * @access private
  * @since 6.2.0
+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
  *
  * @see WP_HTML_Tag_Processor
@@ -24 +25 @@
      *
      * @since 6.2.0
+     *
      * @var string
      */
@@ -32 +34 @@
      *
      * @since 6.2.0
+     *
      * @var int
      */
@@ -40 +43 @@
      *
      * @since 6.2.0
+     *
      * @var int
      */
@@ -48 +52 @@
      *
      * @since 6.2.0
+     *
      * @var int
      */
@@ -53 +58 @@
 
     /**
-     * The string offset after the attribute value or its name.
+     * Byte length of text spanning the attribute inside a tag.
      *
-     * @since 6.2.0
+     * This span starts at the first character of the attribute name
+     * and it ends after one of three cases:
+     *
+     *  - at the end of the attribute name for boolean attributes.
+     *  - at the end of the value for unquoted attributes.
+     *  - at the final single or double quote for quoted attributes.
+     *
+     * Example:
+     *
+     *     <div class="post">
+     *          ------------ length is 12, including quotes
+     *
+     *     <input type="checked" checked id="selector">
+     *                           ------- length is 6
+     *
+     *     <a rel=noopener>
+     *        ------------ length is 11
+     *
+     * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
+     *
      * @var int
      */
-    public $end;
+    public $length;
 
     /**
@@ -64 +88 @@
      *
      * @since 6.2.0
+     *
      * @var bool
      */
@@ -72 +97 @@
      *
      * @since 6.2.0
+     * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
      *
      * @param string $name         Attribute name.
@@ -77 +103 @@
      * @param int    $value_length Number of bytes attribute value spans.
      * @param int    $start        The string offset where the attribute name starts.
-     * @param int    $end          The string offset after the attribute value or its name.
+     * @param int    $length       Byte length of the entire attribute name or name and value pair expression.
      * @param bool   $is_true      Whether the attribute is a boolean attribute with true value.
      */
-    public function __construct( $name, $value_start, $value_length, $start, $end, $is_true ) {
+    public function __construct( $name, $value_start, $value_length, $start, $length, $is_true ) {
         $this->name            = $name;
         $this->value_starts_at = $value_start;
         $this->value_length    = $value_length;
         $this->start           = $start;
-        $this->end             = $end;
+        $this->length          = $length;
         $this->is_true         = $is_true;
     }