Changeset 57179 for trunk/src/wp-includes/html-api/class-wp-html-span.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-span.php (modified) (4 diffs)

trunk/src/wp-includes/html-api/class-wp-html-span.php

@@ -19 +19 @@
  * @access private
  * @since 6.2.0
+ * @since 6.5.0 Replaced `end` with `length` to more closely align with `substr()`.
  *
  * @see WP_HTML_Tag_Processor
@@ -27 +28 @@
      *
      * @since 6.2.0
+     *
      * @var int
      */
@@ -32 +34 @@
 
     /**
-     * Byte offset into document where span ends.
+     * Byte length of this span.
      *
-     * @since 6.2.0
+     * @since 6.5.0
+     *
      * @var int
      */
-    public $end;
+    public $length;
 
     /**
@@ -44 +47 @@
      * @since 6.2.0
      *
-     * @param int $start Byte offset into document where replacement span begins.
-     * @param int $end   Byte offset into document where replacement span ends.
+     * @param int $start  Byte offset into document where replacement span begins.
+     * @param int $length Byte length of span.
      */
-    public function __construct( $start, $end ) {
-        $this->start = $start;
-        $this->end   = $end;
+    public function __construct( $start, $length ) {
+        $this->start  = $start;
+        $this->length = $length;
     }
 }