Fix inherit docs

stevebauman · stevebauman · commit 7de6feb07753 · 2025-12-13T15:02:27.000-05:00
diff --git a/src/Ldap.php b/src/Ldap.php
@@ -62,7 +62,7 @@ public function getAttributes(mixed $entry): array|false
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function countEntries(mixed $result): int
     {
@@ -72,7 +72,7 @@ public function countEntries(mixed $result): int
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function compare(string $dn, string $attribute, string $value, ?array $controls = null): bool|int
     {
@@ -108,7 +108,7 @@ public function getDetailedError(): ?DetailedError
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function getValuesLen(mixed $entry, string $attribute): array|false
     {
@@ -285,7 +285,7 @@ public function bind(?string $dn = null, ?string $password = null, ?array $contr
     }
 
     /**
-     * {@inheritDoc}
+     * {@inheritdoc}
      */
     public function saslBind(?string $dn = null, ?string $password = null, array $options = []): bool
     {
diff --git a/src/Query/Builder.php b/src/Query/Builder.php
@@ -1173,7 +1173,7 @@ public function addFilter(Filter $filter, string $boolean = 'and'): static
         }
 
         // Flatten same-type groups to avoid deeply nested structures.
-        // e.g., AndGroup(AndGroup(a, b), c) becomes AndGroup(a, b, c)
+        // Ex: AndGroup(AndGroup(a, b), c) becomes AndGroup(a, b, c)
         if ($boolean === 'or') {
             $this->filter = $this->filter instanceof OrGroup
                 ? new OrGroup(...[...$this->filter->getFilters(), $filter])
diff --git a/src/Query/Filter/AndGroup.php b/src/Query/Filter/AndGroup.php
@@ -30,23 +30,23 @@ public function getFilters(): array
     }
 
     /**
-     * Get the group's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '&';
     }
 
     /**
-     * Get the raw filter string (without outer parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return '&'.implode('', array_map(fn (Filter $filter) => (string) $filter, $this->filters));
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/ApproximatelyEquals.php b/src/Query/Filter/ApproximatelyEquals.php
@@ -13,39 +13,39 @@ public function __construct(
     ) {}
 
     /**
-     * Get the filter's attribute.
+     * {@inheritdoc}
      */
     public function getAttribute(): string
     {
         return $this->attribute;
     }
 
     /**
-     * Get the filter's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '~=';
     }
 
     /**
-     * Get the filter's value.
+     * {@inheritdoc}
      */
     public function getValue(): string
     {
         return $this->value;
     }
 
     /**
-     * Get the raw filter string (without parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return "{$this->attribute}~={$this->value}";
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/Contains.php b/src/Query/Filter/Contains.php
@@ -13,39 +13,39 @@ public function __construct(
     ) {}
 
     /**
-     * Get the filter's attribute.
+     * {@inheritdoc}
      */
     public function getAttribute(): string
     {
         return $this->attribute;
     }
 
     /**
-     * Get the filter's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '=';
     }
 
     /**
-     * Get the filter's value.
+     * {@inheritdoc}
      */
     public function getValue(): string
     {
         return $this->value;
     }
 
     /**
-     * Get the raw filter string (without parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return "{$this->attribute}=*{$this->value}*";
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/EndsWith.php b/src/Query/Filter/EndsWith.php
@@ -13,39 +13,39 @@ public function __construct(
     ) {}
 
     /**
-     * Get the filter's attribute.
+     * {@inheritdoc}
      */
     public function getAttribute(): string
     {
         return $this->attribute;
     }
 
     /**
-     * Get the filter's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '=';
     }
 
     /**
-     * Get the filter's value.
+     * {@inheritdoc}
      */
     public function getValue(): string
     {
         return $this->value;
     }
 
     /**
-     * Get the raw filter string (without parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return "{$this->attribute}=*{$this->value}";
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/Equals.php b/src/Query/Filter/Equals.php
@@ -13,39 +13,39 @@ public function __construct(
     ) {}
 
     /**
-     * Get the filter's attribute.
+     * {@inheritdoc}
      */
     public function getAttribute(): string
     {
         return $this->attribute;
     }
 
     /**
-     * Get the filter's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '=';
     }
 
     /**
-     * Get the filter's value.
+     * {@inheritdoc}
      */
     public function getValue(): string
     {
         return $this->value;
     }
 
     /**
-     * Get the raw filter string (without parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return "{$this->attribute}={$this->value}";
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/GreaterThanOrEquals.php b/src/Query/Filter/GreaterThanOrEquals.php
@@ -13,39 +13,39 @@ public function __construct(
     ) {}
 
     /**
-     * Get the filter's attribute.
+     * {@inheritdoc}
      */
     public function getAttribute(): string
     {
         return $this->attribute;
     }
 
     /**
-     * Get the filter's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '>=';
     }
 
     /**
-     * Get the filter's value.
+     * {@inheritdoc}
      */
     public function getValue(): string
     {
         return $this->value;
     }
 
     /**
-     * Get the raw filter string (without parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return "{$this->attribute}>={$this->value}";
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/Has.php b/src/Query/Filter/Has.php
@@ -12,39 +12,39 @@ public function __construct(
     ) {}
 
     /**
-     * Get the filter's attribute.
+     * {@inheritdoc}
      */
     public function getAttribute(): string
     {
         return $this->attribute;
     }
 
     /**
-     * Get the filter's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '=';
     }
 
     /**
-     * Get the filter's value.
+     * {@inheritdoc}
      */
     public function getValue(): ?string
     {
         return null;
     }
 
     /**
-     * Get the raw filter string (without parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return "{$this->attribute}=*";
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/LessThanOrEquals.php b/src/Query/Filter/LessThanOrEquals.php
@@ -13,39 +13,39 @@ public function __construct(
     ) {}
 
     /**
-     * Get the filter's attribute.
+     * {@inheritdoc}
      */
     public function getAttribute(): string
     {
         return $this->attribute;
     }
 
     /**
-     * Get the filter's operator.
+     * {@inheritdoc}
      */
     public function getOperator(): string
     {
         return '<=';
     }
 
     /**
-     * Get the filter's value.
+     * {@inheritdoc}
      */
     public function getValue(): string
     {
         return $this->value;
     }
 
     /**
-     * Get the raw filter string (without parentheses).
+     * {@inheritdoc}
      */
     public function getRaw(): string
     {
         return "{$this->attribute}<={$this->value}";
     }
 
     /**
-     * Compile the filter to its LDAP string representation.
+     * {@inheritdoc}
      */
     public function __toString(): string
     {
diff --git a/src/Query/Filter/Not.php b/src/Query/Filter/Not.php
diff --git a/src/Query/Filter/OrGroup.php b/src/Query/Filter/OrGroup.php
diff --git a/src/Query/Filter/Raw.php b/src/Query/Filter/Raw.php
diff --git a/src/Query/Filter/StartsWith.php b/src/Query/Filter/StartsWith.php
diff --git a/src/Testing/LdapFake.php b/src/Testing/LdapFake.php

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function getAttributes(mixed $entry): array\|false`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`/**`
`65`		`- * {@inheritDoc}`
	`65`	`+ * {@inheritdoc}`
`66`	`66`	`*/`
`67`	`67`	`public function countEntries(mixed $result): int`
`68`	`68`	`{`
`@@ -72,7 +72,7 @@ public function countEntries(mixed $result): int`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`/**`
`75`		`- * {@inheritDoc}`
	`75`	`+ * {@inheritdoc}`
`76`	`76`	`*/`
`77`	`77`	`public function compare(string $dn, string $attribute, string $value, ?array $controls = null): bool\|int`
`78`	`78`	`{`
`@@ -108,7 +108,7 @@ public function getDetailedError(): ?DetailedError`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`/**`
`111`		`- * {@inheritDoc}`
	`111`	`+ * {@inheritdoc}`
`112`	`112`	`*/`
`113`	`113`	`public function getValuesLen(mixed $entry, string $attribute): array\|false`
`114`	`114`	`{`
`@@ -285,7 +285,7 @@ public function bind(?string $dn = null, ?string $password = null, ?array $contr`
`285`	`285`	`}`
`286`	`286`
`287`	`287`	`/**`
`288`		`- * {@inheritDoc}`
	`288`	`+ * {@inheritdoc}`
`289`	`289`	`*/`
`290`	`290`	`public function saslBind(?string $dn = null, ?string $password = null, array $options = []): bool`
`291`	`291`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1173,7 +1173,7 @@ public function addFilter(Filter $filter, string $boolean = 'and'): static`
`1173`	`1173`	`}`
`1174`	`1174`
`1175`	`1175`	`// Flatten same-type groups to avoid deeply nested structures.`
`1176`		`- // e.g., AndGroup(AndGroup(a, b), c) becomes AndGroup(a, b, c)`
	`1176`	`+ // Ex: AndGroup(AndGroup(a, b), c) becomes AndGroup(a, b, c)`
`1177`	`1177`	`if ($boolean === 'or') {`
`1178`	`1178`	`$this->filter = $this->filter instanceof OrGroup`
`1179`	`1179`	`? new OrGroup(...[...$this->filter->getFilters(), $filter])`
Original file line number	Diff line number	Diff line change
`@@ -30,23 +30,23 @@ public function getFilters(): array`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`/**`
`33`		`- * Get the group's operator.`
	`33`	`+ * {@inheritdoc}`
`34`	`34`	`*/`
`35`	`35`	`public function getOperator(): string`
`36`	`36`	`{`
`37`	`37`	`return '&';`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`/**`
`41`		`- * Get the raw filter string (without outer parentheses).`
	`41`	`+ * {@inheritdoc}`
`42`	`42`	`*/`
`43`	`43`	`public function getRaw(): string`
`44`	`44`	`{`
`45`	`45`	`return '&'.implode('', array_map(fn (Filter $filter) => (string) $filter, $this->filters));`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/**`
`49`		`- * Compile the filter to its LDAP string representation.`
	`49`	`+ * {@inheritdoc}`
`50`	`50`	`*/`
`51`	`51`	`public function __toString(): string`
`52`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,39 +13,39 @@ public function __construct(`
`13`	`13`	`) {}`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * Get the filter's attribute.`
	`16`	`+ * {@inheritdoc}`
`17`	`17`	`*/`
`18`	`18`	`public function getAttribute(): string`
`19`	`19`	`{`
`20`	`20`	`return $this->attribute;`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * Get the filter's operator.`
	`24`	`+ * {@inheritdoc}`
`25`	`25`	`*/`
`26`	`26`	`public function getOperator(): string`
`27`	`27`	`{`
`28`	`28`	`return '~=';`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`/**`
`32`		`- * Get the filter's value.`
	`32`	`+ * {@inheritdoc}`
`33`	`33`	`*/`
`34`	`34`	`public function getValue(): string`
`35`	`35`	`{`
`36`	`36`	`return $this->value;`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/**`
`40`		`- * Get the raw filter string (without parentheses).`
	`40`	`+ * {@inheritdoc}`
`41`	`41`	`*/`
`42`	`42`	`public function getRaw(): string`
`43`	`43`	`{`
`44`	`44`	`return "{$this->attribute}~={$this->value}";`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`/**`
`48`		`- * Compile the filter to its LDAP string representation.`
	`48`	`+ * {@inheritdoc}`
`49`	`49`	`*/`
`50`	`50`	`public function __toString(): string`
`51`	`51`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,39 +12,39 @@ public function __construct(`
`12`	`12`	`) {}`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * Get the filter's attribute.`
	`15`	`+ * {@inheritdoc}`
`16`	`16`	`*/`
`17`	`17`	`public function getAttribute(): string`
`18`	`18`	`{`
`19`	`19`	`return $this->attribute;`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`/**`
`23`		`- * Get the filter's operator.`
	`23`	`+ * {@inheritdoc}`
`24`	`24`	`*/`
`25`	`25`	`public function getOperator(): string`
`26`	`26`	`{`
`27`	`27`	`return '=';`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * Get the filter's value.`
	`31`	`+ * {@inheritdoc}`
`32`	`32`	`*/`
`33`	`33`	`public function getValue(): ?string`
`34`	`34`	`{`
`35`	`35`	`return null;`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`/**`
`39`		`- * Get the raw filter string (without parentheses).`
	`39`	`+ * {@inheritdoc}`
`40`	`40`	`*/`
`41`	`41`	`public function getRaw(): string`
`42`	`42`	`{`
`43`	`43`	`return "{$this->attribute}=*";`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`/**`
`47`		`- * Compile the filter to its LDAP string representation.`
	`47`	`+ * {@inheritdoc}`
`48`	`48`	`*/`
`49`	`49`	`public function __toString(): string`
`50`	`50`	`{`