Deprecate Detail methods

t-regx · Feb 23, 2024 · a1c82f4 · a1c82f4
1 parent 408f831
commit a1c82f4
Show file tree

Hide file tree

Showing 6 changed files with 93 additions and 0 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -33,6 +33,25 @@ Incoming
       * Deprecate `Matcher.groupNames()`
       * Deprecate `Matcher.groupsCount()`
       * Deprecate `Matcher.groupExists()`
+   * Deprecate `Detail` methods unqualified for release candidate.
+      * Deprecate `Detail.get()`, to be renamed to `.group()`
+      * Deprecate `Detail.group()`, to be refactored to return `string`
+      * Deprecate `Detail.groups()`
+      * Deprecate `Detail.namedGroups()`
+      * Deprecate `Detail.matched()`, to be renamed to `.groupMatched()`
+      * Deprecate `Detail.all()`
+      * Deprecate `Detail.groupNames()`
+      * Deprecate `Detail.groupsCount()`
+      * Deprecate `Detail.byteLength()`
+      * Deprecate `Detail.offset()`, to be renamed to `.start()`
+      * Deprecate `Detail.tail()`,  to be renamed to `.end()`
+      * Deprecate `Detail.length()`
+      * Deprecate `Detail.byteOffset()`, to be renamed to `.byteStart()`
+      * Deprecate `Detail.byteTail()`, to be renamed to `.byteEnd()`
+      * Deprecate `Detail.byteLength()`
+      * Deprecate `Detail.toInt()`
+      * Deprecate `Detail.isInt()`
+      * Deprecate `Intable`
 
 Added in 0.41.5
 ---------------

diff --git a/src/CleanRegex/Internal/Match/Details/MatchDetail.php b/src/CleanRegex/Internal/Match/Details/MatchDetail.php
@@ -67,21 +67,33 @@ public function text(): string
         return $this->scalars->matchedText();
     }
 
+    /**
+     * @deprecated
+     */
     public function length(): int
     {
         return $this->coordinate->characterLength();
     }
 
+    /**
+     * @deprecated
+     */
     public function byteLength(): int
     {
         return $this->coordinate->byteLength();
     }
 
+    /**
+     * @deprecated
+     */
     public function toInt(int $base = 10): int
     {
         return $this->numericDetail->asInteger(new Base($base));
     }
 
+    /**
+     * @deprecated
+     */
     public function isInt(int $base = 10): bool
     {
         return $this->numericDetail->isInteger(new Base($base));
@@ -90,6 +102,7 @@ public function isInt(int $base = 10): bool
     /**
      * @param string|int $nameOrIndex
      * @return string
+     * @deprecated
      */
     public function get($nameOrIndex): string
     {
@@ -99,6 +112,7 @@ public function get($nameOrIndex): string
     /**
      * @param string|int $nameOrIndex
      * @return Group
+     * @deprecated
      */
     public function group($nameOrIndex): Group
     {
@@ -117,6 +131,7 @@ public function groupExists($nameOrIndex): bool
     /**
      * @param string|int $nameOrIndex
      * @return bool
+     * @deprecated
      */
     public function matched($nameOrIndex): bool
     {
@@ -125,19 +140,24 @@ public function matched($nameOrIndex): bool
 
     /**
      * @return (string|null)[]
+     * @deprecated
      */
     public function groupNames(): array
     {
         return $this->groupNames->groupNames();
     }
 
+    /**
+     * @deprecated
+     */
     public function groupsCount(): int
     {
         return $this->groupsCount->groupsCount();
     }
 
     /**
      * @return Group[]
+     * @deprecated
      */
     public function groups(): array
     {
@@ -146,6 +166,7 @@ public function groups(): array
 
     /**
      * @return Group[]
+     * @deprecated
      */
     public function namedGroups(): array
     {
@@ -154,27 +175,40 @@ public function namedGroups(): array
 
     /**
      * @return string[]
+     * @deprecated
      */
     public function all(): array
     {
         return $this->scalars->otherTexts();
     }
 
+    /**
+     * @deprecated
+     */
     public function offset(): int
     {
         return $this->coordinate->characterOffset();
     }
 
+    /**
+     * @deprecated
+     */
     public function tail(): int
     {
         return $this->coordinate->characterTail();
     }
 
+    /**
+     * @deprecated
+     */
     public function byteOffset(): int
     {
         return $this->coordinate->byteOffset();
     }
 
+    /**
+     * @deprecated
+     */
     public function byteTail(): int
     {
         return $this->coordinate->byteTail();

diff --git a/src/CleanRegex/Internal/Match/Intable.php b/src/CleanRegex/Internal/Match/Intable.php
@@ -1,7 +1,13 @@
 <?php
 namespace TRegx\CleanRegex\Internal\Match;
 
+/**
+ * @deprecated
+ */
 interface Intable
 {
+    /**
+     * @deprecated
+     */
     public function toInt(int $base = 10): int;
 }
diff --git a/src/CleanRegex/Match/Detail.php b/src/CleanRegex/Match/Detail.php
@@ -8,33 +8,39 @@ public function index(): int;
     /**
      * @param string|int $nameOrIndex
      * @return string
+     * @deprecated
      */
     public function get($nameOrIndex): string;
 
     /**
      * @param string|int $nameOrIndex
      * @return Group
+     * @deprecated
      */
     public function group($nameOrIndex): Group;
 
     /**
      * @return Group[]
+     * @deprecated
      */
     public function groups(): array;
 
     /**
      * @return Group[]
+     * @deprecated
      */
     public function namedGroups(): array;
 
     /**
      * @param string|int $nameOrIndex
      * @return bool
+     * @deprecated
      */
     public function matched($nameOrIndex): bool;
 
     /**
      * @return string[]
+     * @deprecated
      */
     public function all(): array;
 

diff --git a/src/CleanRegex/Match/Element.php b/src/CleanRegex/Match/Element.php
@@ -7,20 +7,44 @@ interface Element extends Intable
 {
     public function text(): string;
 
+    /**
+     * @deprecated
+     */
     public function toInt(int $base = 10): int;
 
+    /**
+     * @deprecated
+     */
     public function isInt(int $base = 10): bool;
 
+    /**
+     * @deprecated
+     */
     public function offset(): int;
 
+    /**
+     * @deprecated
+     */
     public function tail(): int;
 
+    /**
+     * @deprecated
+     */
     public function length(): int;
 
+    /**
+     * @deprecated
+     */
     public function byteOffset(): int;
 
+    /**
+     * @deprecated
+     */
     public function byteTail(): int;
 
+    /**
+     * @deprecated 
+     */
     public function byteLength(): int;
 
     public function subject(): string;

diff --git a/src/CleanRegex/Match/Structure.php b/src/CleanRegex/Match/Structure.php
@@ -7,9 +7,13 @@ public function subject(): string;
 
     /**
      * @return (string|null)[]
+     * @deprecated
      */
     public function groupNames(): array;
 
+    /**
+     * @deprecated
+     */
     public function groupsCount(): int;
 
     /**