Element // improve return types by using "static" instead of the specific class or implemented interface.

Christian Leucht · Christian Leucht · commit fbc016f38153 · 2023-07-11T15:34:13.000+02:00
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,31 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.3/phpunit.xsd"
-	backupGlobals="false"
-	backupStaticAttributes="false"
-	bootstrap="tests/phpunit/bootstrap.php"
-	colors="true"
-	convertErrorsToExceptions="true"
-	convertNoticesToExceptions="true"
-	convertWarningsToExceptions="true"
-	processIsolation="false"
-	stopOnFailure="false">
-	<testsuites>
-		<testsuite name="Unit">
-			<directory suffix="Test.php">tests/phpunit/Unit</directory>
-		</testsuite>
-	</testsuites>
-	<filter>
-		<whitelist processUncoveredFilesFromWhitelist="true">
-			<directory suffix=".php">src</directory>
-			<exclude>
-				<directory>tests</directory>
-				<directory>vendor</directory>
-			</exclude>
-		</whitelist>
-	</filter>
-	<logging>
-		<log type="coverage-html" target="tmp"/>
-	</logging>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" backupStaticAttributes="false" bootstrap="tests/phpunit/bootstrap.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <exclude>
+      <directory>tests</directory>
+      <directory>vendor</directory>
+    </exclude>
+    <report>
+      <html outputDirectory="tmp"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="Unit">
+      <directory suffix="Test.php">tests/phpunit/Unit</directory>
+    </testsuite>
+  </testsuites>
+  <logging/>
 </phpunit>
diff --git a/src/Element/ChoiceElement.php b/src/Element/ChoiceElement.php
@@ -17,9 +17,9 @@ class ChoiceElement extends Element implements ChoiceElementInterface
     /**
      * @param ChoiceListInterface $list
      *
-     * @return ChoiceElement
+     * @return static
      */
-    public function withChoices(ChoiceListInterface $list): ChoiceElement
+    public function withChoices(ChoiceListInterface $list): static
     {
         $this->list = $list;
 
diff --git a/src/Element/CollectionElement.php b/src/Element/CollectionElement.php
@@ -33,9 +33,9 @@ class CollectionElement extends Element implements CollectionElementInterface
     /**
      * @param ElementInterface[] $elements
      *
-     * @return CollectionElement
+     * @return static
      */
-    public function withElement(ElementInterface ...$elements): CollectionElement
+    public function withElement(ElementInterface ...$elements): static
     {
         array_walk(
             $elements,
@@ -81,9 +81,9 @@ public function elementExists(string $name): bool
      * @param string $key
      * @param bool|int|string $value
      *
-     * @return CollectionElement
+     * @return static
      */
-    public function withAttribute(string $key, $value): ElementInterface
+    public function withAttribute(string $key, $value): static
     {
         if ($key === 'value' && is_array($value)) {
             foreach ($this->elements as $name => $element) {
@@ -130,9 +130,9 @@ public function elements(): array
      *
      * @param array $errors
      *
-     * @return CollectionElement
+     * @return static
      */
-    public function withErrors(array $errors = []): CollectionElement
+    public function withErrors(array $errors = []): static
     {
         $this->allErrors = $errors;
 
diff --git a/src/Element/DescriptionAwareTrait.php b/src/Element/DescriptionAwareTrait.php
@@ -21,9 +21,9 @@ public function description(): string
     /**
      * @param string $description
      *
-     * @return self
+     * @return static
      */
-    public function withDescription(string $description)
+    public function withDescription(string $description): static
     {
         $this->description = $description;
 
diff --git a/src/Element/Element.php b/src/Element/Element.php
@@ -44,9 +44,9 @@ public function __construct(string $name)
      * @param string $key
      * @param bool|int|string $value
      *
-     * @return Element
+     * @return static
      */
-    public function withAttribute(string $key, $value): ElementInterface
+    public function withAttribute(string $key, $value): static
     {
         $this->attributes[$key] = $value;
 
@@ -114,9 +114,9 @@ public function value()
     /**
      * @param string $value
      *
-     * @return Element
+     * @return static
      */
-    public function withValue($value): Element
+    public function withValue($value): static
     {
         $this->withAttribute('value', $value);
 
@@ -134,9 +134,9 @@ public function attributes(): array
     /**
      * @param array $attributes
      *
-     * @return Element
+     * @return static
      */
-    public function withAttributes(array $attributes = []): Element
+    public function withAttributes(array $attributes = []): static
     {
         $this->attributes = array_merge(
             $this->attributes,
@@ -157,9 +157,9 @@ public function options(): array
     /**
      * @param array $options
      *
-     * @return Element
+     * @return static
      */
-    public function withOptions(array $options = []): Element
+    public function withOptions(array $options = []): static
     {
         $this->options = array_merge(
             $this->options,
@@ -173,9 +173,9 @@ public function withOptions(array $options = []): Element
      * @param string $key
      * @param int|string $value
      *
-     * @return Element
+     * @return static
      */
-    public function withOption(string $key, $value): Element
+    public function withOption(string $key, $value): static
     {
         $this->options[$key] = $value;
 
@@ -199,9 +199,9 @@ public function option(string $key)
     /**
      * @param callable $callable
      *
-     * @return $this
+     * @return static
      */
-    public function withFilter(callable $callable): Element
+    public function withFilter(callable $callable): static
     {
         $this->filter = $callable;
 
@@ -220,9 +220,9 @@ public function filter($value)
     /**
      * @param callable $callable
      *
-     * @return $this
+     * @return static
      */
-    public function withValidator(callable $callable): Element
+    public function withValidator(callable $callable): static
     {
         $this->validator = $callable;
 
diff --git a/src/Element/ErrorAwareTrait.php b/src/Element/ErrorAwareTrait.php
@@ -26,9 +26,9 @@ public function errors(): array
     /**
      * @param array $errors
      *
-     * @return self
+     * @return static
      */
-    public function withErrors(array $errors = [])
+    public function withErrors(array $errors = []): static
     {
         $this->errors = array_merge($this->errors, $errors);
 
diff --git a/src/Element/Form.php b/src/Element/Form.php
@@ -34,11 +34,11 @@ class Form extends CollectionElement implements FormInterface
      * @param string $key
      * @param string|array $value
      *
-     * @return ElementInterface
+     * @return static
      * @throws LogicException
      *
      */
-    public function withAttribute(string $key, $value): ElementInterface
+    public function withAttribute(string $key, $value): static
     {
         if ($key === 'value' && is_array($value)) {
             $this->withData($value);
@@ -52,11 +52,11 @@ public function withAttribute(string $key, $value): ElementInterface
     /**
      * @param array $data
      *
-     * @return FormInterface
+     * @return static
      * @throws LogicException
      *
      */
-    public function withData(array $data = []): FormInterface
+    public function withData(array $data = []): static
     {
         if ($this->isSubmitted) {
             throw new LogicException('You cannot change data of a submitted form.');
diff --git a/src/Element/LabelAwareInterface.php b/src/Element/LabelAwareInterface.php
@@ -22,8 +22,6 @@ public function labelAttributes(): array;
 
     /**
      * @param array $labelAttributes
-     *
-     * @return self
      */
     public function withLabelAttributes(array $labelAttributes = []);
 }
diff --git a/tests/phpunit/Unit/View/FormTest.php b/tests/phpunit/Unit/View/FormTest.php
@@ -48,6 +48,8 @@ public function testRender(): void
         $expected_name = 'foo';
 
         $element_stub = Mockery::mock(ElementInterface::class);
+        $element_stub->allows('id')
+            ->andReturn($expected_name);
         $element_stub->allows('name')
             ->andReturn($expected_name);
         $element_stub->allows('type')

Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,9 @@ class ChoiceElement extends Element implements ChoiceElementInterface`
`17`	`17`	`/**`
`18`	`18`	`* @param ChoiceListInterface $list`
`19`	`19`	`*`
`20`		`- * @return ChoiceElement`
	`20`	`+ * @return static`
`21`	`21`	`*/`
`22`		`- public function withChoices(ChoiceListInterface $list): ChoiceElement`
	`22`	`+ public function withChoices(ChoiceListInterface $list): static`
`23`	`23`	`{`
`24`	`24`	`$this->list = $list;`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,9 @@ class CollectionElement extends Element implements CollectionElementInterface`
`33`	`33`	`/**`
`34`	`34`	`* @param ElementInterface[] $elements`
`35`	`35`	`*`
`36`		`- * @return CollectionElement`
	`36`	`+ * @return static`
`37`	`37`	`*/`
`38`		`- public function withElement(ElementInterface ...$elements): CollectionElement`
	`38`	`+ public function withElement(ElementInterface ...$elements): static`
`39`	`39`	`{`
`40`	`40`	`array_walk(`
`41`	`41`	`$elements,`
`@@ -81,9 +81,9 @@ public function elementExists(string $name): bool`
`81`	`81`	`* @param string $key`
`82`	`82`	`* @param bool\|int\|string $value`
`83`	`83`	`*`
`84`		`- * @return CollectionElement`
	`84`	`+ * @return static`
`85`	`85`	`*/`
`86`		`- public function withAttribute(string $key, $value): ElementInterface`
	`86`	`+ public function withAttribute(string $key, $value): static`
`87`	`87`	`{`
`88`	`88`	`if ($key === 'value' && is_array($value)) {`
`89`	`89`	`foreach ($this->elements as $name => $element) {`
`@@ -130,9 +130,9 @@ public function elements(): array`
`130`	`130`	`*`
`131`	`131`	`* @param array $errors`
`132`	`132`	`*`
`133`		`- * @return CollectionElement`
	`133`	`+ * @return static`
`134`	`134`	`*/`
`135`		`- public function withErrors(array $errors = []): CollectionElement`
	`135`	`+ public function withErrors(array $errors = []): static`
`136`	`136`	`{`
`137`	`137`	`$this->allErrors = $errors;`
`138`	`138`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,9 @@ public function description(): string`
`21`	`21`	`/**`
`22`	`22`	`* @param string $description`
`23`	`23`	`*`
`24`		`- * @return self`
	`24`	`+ * @return static`
`25`	`25`	`*/`
`26`		`- public function withDescription(string $description)`
	`26`	`+ public function withDescription(string $description): static`
`27`	`27`	`{`
`28`	`28`	`$this->description = $description;`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -44,9 +44,9 @@ public function __construct(string $name)`
`44`	`44`	`* @param string $key`
`45`	`45`	`* @param bool\|int\|string $value`
`46`	`46`	`*`
`47`		`- * @return Element`
	`47`	`+ * @return static`
`48`	`48`	`*/`
`49`		`- public function withAttribute(string $key, $value): ElementInterface`
	`49`	`+ public function withAttribute(string $key, $value): static`
`50`	`50`	`{`
`51`	`51`	`$this->attributes[$key] = $value;`
`52`	`52`
`@@ -114,9 +114,9 @@ public function value()`
`114`	`114`	`/**`
`115`	`115`	`* @param string $value`
`116`	`116`	`*`
`117`		`- * @return Element`
	`117`	`+ * @return static`
`118`	`118`	`*/`
`119`		`- public function withValue($value): Element`
	`119`	`+ public function withValue($value): static`
`120`	`120`	`{`
`121`	`121`	`$this->withAttribute('value', $value);`
`122`	`122`
`@@ -134,9 +134,9 @@ public function attributes(): array`
`134`	`134`	`/**`
`135`	`135`	`* @param array $attributes`
`136`	`136`	`*`
`137`		`- * @return Element`
	`137`	`+ * @return static`
`138`	`138`	`*/`
`139`		`- public function withAttributes(array $attributes = []): Element`
	`139`	`+ public function withAttributes(array $attributes = []): static`
`140`	`140`	`{`
`141`	`141`	`$this->attributes = array_merge(`
`142`	`142`	`$this->attributes,`
`@@ -157,9 +157,9 @@ public function options(): array`
`157`	`157`	`/**`
`158`	`158`	`* @param array $options`
`159`	`159`	`*`
`160`		`- * @return Element`
	`160`	`+ * @return static`
`161`	`161`	`*/`
`162`		`- public function withOptions(array $options = []): Element`
	`162`	`+ public function withOptions(array $options = []): static`
`163`	`163`	`{`
`164`	`164`	`$this->options = array_merge(`
`165`	`165`	`$this->options,`
`@@ -173,9 +173,9 @@ public function withOptions(array $options = []): Element`
`173`	`173`	`* @param string $key`
`174`	`174`	`* @param int\|string $value`
`175`	`175`	`*`
`176`		`- * @return Element`
	`176`	`+ * @return static`
`177`	`177`	`*/`
`178`		`- public function withOption(string $key, $value): Element`
	`178`	`+ public function withOption(string $key, $value): static`
`179`	`179`	`{`
`180`	`180`	`$this->options[$key] = $value;`
`181`	`181`
`@@ -199,9 +199,9 @@ public function option(string $key)`
`199`	`199`	`/**`
`200`	`200`	`* @param callable $callable`
`201`	`201`	`*`
`202`		`- * @return $this`
	`202`	`+ * @return static`
`203`	`203`	`*/`
`204`		`- public function withFilter(callable $callable): Element`
	`204`	`+ public function withFilter(callable $callable): static`
`205`	`205`	`{`
`206`	`206`	`$this->filter = $callable;`
`207`	`207`
`@@ -220,9 +220,9 @@ public function filter($value)`
`220`	`220`	`/**`
`221`	`221`	`* @param callable $callable`
`222`	`222`	`*`
`223`		`- * @return $this`
	`223`	`+ * @return static`
`224`	`224`	`*/`
`225`		`- public function withValidator(callable $callable): Element`
	`225`	`+ public function withValidator(callable $callable): static`
`226`	`226`	`{`
`227`	`227`	`$this->validator = $callable;`
`228`	`228`
Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,9 @@ public function errors(): array`
`26`	`26`	`/**`
`27`	`27`	`* @param array $errors`
`28`	`28`	`*`
`29`		`- * @return self`
	`29`	`+ * @return static`
`30`	`30`	`*/`
`31`		`- public function withErrors(array $errors = [])`
	`31`	`+ public function withErrors(array $errors = []): static`
`32`	`32`	`{`
`33`	`33`	`$this->errors = array_merge($this->errors, $errors);`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -34,11 +34,11 @@ class Form extends CollectionElement implements FormInterface`
`34`	`34`	`* @param string $key`
`35`	`35`	`* @param string\|array $value`
`36`	`36`	`*`
`37`		`- * @return ElementInterface`
	`37`	`+ * @return static`
`38`	`38`	`* @throws LogicException`
`39`	`39`	`*`
`40`	`40`	`*/`
`41`		`- public function withAttribute(string $key, $value): ElementInterface`
	`41`	`+ public function withAttribute(string $key, $value): static`
`42`	`42`	`{`
`43`	`43`	`if ($key === 'value' && is_array($value)) {`
`44`	`44`	`$this->withData($value);`
`@@ -52,11 +52,11 @@ public function withAttribute(string $key, $value): ElementInterface`
`52`	`52`	`/**`
`53`	`53`	`* @param array $data`
`54`	`54`	`*`
`55`		`- * @return FormInterface`
	`55`	`+ * @return static`
`56`	`56`	`* @throws LogicException`
`57`	`57`	`*`
`58`	`58`	`*/`
`59`		`- public function withData(array $data = []): FormInterface`
	`59`	`+ public function withData(array $data = []): static`
`60`	`60`	`{`
`61`	`61`	`if ($this->isSubmitted) {`
`62`	`62`	`throw new LogicException('You cannot change data of a submitted form.');`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,6 @@ public function labelAttributes(): array;`
`22`	`22`
`23`	`23`	`/**`
`24`	`24`	`* @param array $labelAttributes`
`25`		`- *`
`26`		`- * @return self`
`27`	`25`	`*/`
`28`	`26`	`public function withLabelAttributes(array $labelAttributes = []);`
`29`	`27`	`}`