[WebLink] Add NoDiscard and phpdoc types

GromNaN · GromNaN · commit 99e84e92bfb9 · 2025-05-15T15:34:06.000+02:00
diff --git a/src/Symfony/Component/WebLink/CHANGELOG.md b/src/Symfony/Component/WebLink/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add `#[NoDiscard]` attribute to `Link` and `GenericLinkProvider` with methods
+
 4.4.0
 -----
 
diff --git a/src/Symfony/Component/WebLink/GenericLinkProvider.php b/src/Symfony/Component/WebLink/GenericLinkProvider.php
@@ -53,6 +53,7 @@ public function getLinksByRel(string $rel): array
         return $links;
     }
 
+    #[\NoDiscard]
     public function withLink(LinkInterface $link): static
     {
         $that = clone $this;
@@ -61,6 +62,7 @@ public function withLink(LinkInterface $link): static
         return $that;
     }
 
+    #[\NoDiscard]
     public function withoutLink(LinkInterface $link): static
     {
         $that = clone $this;
diff --git a/src/Symfony/Component/WebLink/Link.php b/src/Symfony/Component/WebLink/Link.php
@@ -175,11 +175,17 @@ public function getRels(): array
         return array_values($this->rel);
     }
 
+    /**
+     * Returns a list of attributes that describe the target URI.
+     *
+     * @return array<string, scalar|\Stringable|list<scalar|\Stringable>>
+     */
     public function getAttributes(): array
     {
         return $this->attributes;
     }
 
+    #[\NoDiscard]
     public function withHref(string|\Stringable $href): static
     {
         $that = clone $this;
@@ -188,6 +194,7 @@ public function withHref(string|\Stringable $href): static
         return $that;
     }
 
+    #[\NoDiscard]
     public function withRel(string $rel): static
     {
         $that = clone $this;
@@ -196,6 +203,7 @@ public function withRel(string $rel): static
         return $that;
     }
 
+    #[\NoDiscard]
     public function withoutRel(string $rel): static
     {
         $that = clone $this;
@@ -204,6 +212,15 @@ public function withoutRel(string $rel): static
         return $that;
     }
 
+    /**
+     * Returns an instance with the specified attribute added.
+     *
+     * If the specified attribute is already present, it will be overwritten
+     * with the new value.
+     *
+     * @param scalar|\Stringable|list<scalar|\Stringable> $value
+     */
+    #[\NoDiscard]
     public function withAttribute(string $attribute, string|\Stringable|int|float|bool|array $value): static
     {
         $that = clone $this;
@@ -212,6 +229,7 @@ public function withAttribute(string $attribute, string|\Stringable|int|float|bo
         return $that;
     }
 
+    #[\NoDiscard]
     public function withoutAttribute(string $attribute): static
     {
         $that = clone $this;

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ public function getLinksByRel(string $rel): array`
`53`	`53`	`return $links;`
`54`	`54`	`}`
`55`	`55`
	`56`	`+ #[\NoDiscard]`
`56`	`57`	`public function withLink(LinkInterface $link): static`
`57`	`58`	`{`
`58`	`59`	`$that = clone $this;`
`@@ -61,6 +62,7 @@ public function withLink(LinkInterface $link): static`
`61`	`62`	`return $that;`
`62`	`63`	`}`
`63`	`64`
	`65`	`+ #[\NoDiscard]`
`64`	`66`	`public function withoutLink(LinkInterface $link): static`
`65`	`67`	`{`
`66`	`68`	`$that = clone $this;`
Original file line number	Diff line number	Diff line change
`@@ -175,11 +175,17 @@ public function getRels(): array`
`175`	`175`	`return array_values($this->rel);`
`176`	`176`	`}`
`177`	`177`
	`178`	`+ /**`
	`179`	`+ * Returns a list of attributes that describe the target URI.`
	`180`	`+ *`
	`181`	`+ * @return array<string, scalar\|\Stringable\|list<scalar\|\Stringable>>`
	`182`	`+ */`
`178`	`183`	`public function getAttributes(): array`
`179`	`184`	`{`
`180`	`185`	`return $this->attributes;`
`181`	`186`	`}`
`182`	`187`
	`188`	`+ #[\NoDiscard]`
`183`	`189`	`public function withHref(string\|\Stringable $href): static`
`184`	`190`	`{`
`185`	`191`	`$that = clone $this;`
`@@ -188,6 +194,7 @@ public function withHref(string\|\Stringable $href): static`
`188`	`194`	`return $that;`
`189`	`195`	`}`
`190`	`196`
	`197`	`+ #[\NoDiscard]`
`191`	`198`	`public function withRel(string $rel): static`
`192`	`199`	`{`
`193`	`200`	`$that = clone $this;`
`@@ -196,6 +203,7 @@ public function withRel(string $rel): static`
`196`	`203`	`return $that;`
`197`	`204`	`}`
`198`	`205`
	`206`	`+ #[\NoDiscard]`
`199`	`207`	`public function withoutRel(string $rel): static`
`200`	`208`	`{`
`201`	`209`	`$that = clone $this;`
`@@ -204,6 +212,15 @@ public function withoutRel(string $rel): static`
`204`	`212`	`return $that;`
`205`	`213`	`}`
`206`	`214`
	`215`	`+ /**`
	`216`	`+ * Returns an instance with the specified attribute added.`
	`217`	`+ *`
	`218`	`+ * If the specified attribute is already present, it will be overwritten`
	`219`	`+ * with the new value.`
	`220`	`+ *`
	`221`	`+ * @param scalar\|\Stringable\|list<scalar\|\Stringable> $value`
	`222`	`+ */`
	`223`	`+ #[\NoDiscard]`
`207`	`224`	`public function withAttribute(string $attribute, string\|\Stringable\|int\|float\|bool\|array $value): static`
`208`	`225`	`{`
`209`	`226`	`$that = clone $this;`
`@@ -212,6 +229,7 @@ public function withAttribute(string $attribute, string\|\Stringable\|int\|float\|bo`
`212`	`229`	`return $that;`
`213`	`230`	`}`
`214`	`231`
	`232`	`+ #[\NoDiscard]`
`215`	`233`	`public function withoutAttribute(string $attribute): static`
`216`	`234`	`{`
`217`	`235`	`$that = clone $this;`