Narrow existing return types on private/internal/final/test methods

Author: nicolas-grekas

Crypto/DkimOptions.php

@@ -25,70 +25,49 @@ public function toArray(): array
         return $this->options;
     }
 
-    /**
-     * @return $this
-     */
-    public function algorithm(int $algo): self
+    public function algorithm(int $algo): static
     {
         $this->options['algorithm'] = $algo;
 
         return $this;
     }
 
-    /**
-     * @return $this
-     */
-    public function signatureExpirationDelay(int $show): self
+    public function signatureExpirationDelay(int $show): static
     {
         $this->options['signature_expiration_delay'] = $show;
 
         return $this;
     }
 
-    /**
-     * @return $this
-     */
-    public function bodyMaxLength(int $max): self
+    public function bodyMaxLength(int $max): static
     {
         $this->options['body_max_length'] = $max;
 
         return $this;
     }
 
-    /**
-     * @return $this
-     */
-    public function bodyShowLength(bool $show): self
+    public function bodyShowLength(bool $show): static
     {
         $this->options['body_show_length'] = $show;
 
         return $this;
     }
 
-    /**
-     * @return $this
-     */
-    public function headerCanon(string $canon): self
+    public function headerCanon(string $canon): static
     {
         $this->options['header_canon'] = $canon;
 
         return $this;
     }
 
-    /**
-     * @return $this
-     */
-    public function bodyCanon(string $canon): self
+    public function bodyCanon(string $canon): static
     {
         $this->options['body_canon'] = $canon;
 
         return $this;
     }
 
-    /**
-     * @return $this
-     */
-    public function headersToIgnore(array $headers): self
+    public function headersToIgnore(array $headers): static
     {
         $this->options['headers_to_ignore'] = $headers;
 

Email.php

@@ -491,10 +491,7 @@ private function createDataPart(array $attachment): DataPart
         return $part;
     }
 
-    /**
-     * @return $this
-     */
-    private function setHeaderBody(string $type, string $name, $body): object
+    private function setHeaderBody(string $type, string $name, $body): static
     {
         $this->getHeaders()->setHeaderBody($type, $name, $body);
 

Header/Headers.php

@@ -76,66 +76,43 @@ public function getMaxLineLength(): int
 
     /**
      * @param array<Address|string> $addresses
-     *
-     * @return $this
      */
-    public function addMailboxListHeader(string $name, array $addresses): self
+    public function addMailboxListHeader(string $name, array $addresses): static
     {
         return $this->add(new MailboxListHeader($name, Address::createArray($addresses)));
     }
 
-    /**
-     * @return $this
-     */
-    public function addMailboxHeader(string $name, Address|string $address): self
+    public function addMailboxHeader(string $name, Address|string $address): static
     {
         return $this->add(new MailboxHeader($name, Address::create($address)));
     }
 
-    /**
-     * @return $this
-     */
-    public function addIdHeader(string $name, string|array $ids): self
+    public function addIdHeader(string $name, string|array $ids): static
     {
         return $this->add(new IdentificationHeader($name, $ids));
     }
 
-    /**
-     * @return $this
-     */
-    public function addPathHeader(string $name, Address|string $path): self
+    public function addPathHeader(string $name, Address|string $path): static
     {
         return $this->add(new PathHeader($name, $path instanceof Address ? $path : new Address($path)));
     }
 
-    /**
-     * @return $this
-     */
-    public function addDateHeader(string $name, \DateTimeInterface $dateTime): self
+    public function addDateHeader(string $name, \DateTimeInterface $dateTime): static
     {
         return $this->add(new DateHeader($name, $dateTime));
     }
 
-    /**
-     * @return $this
-     */
-    public function addTextHeader(string $name, string $value): self
+    public function addTextHeader(string $name, string $value): static
     {
         return $this->add(new UnstructuredHeader($name, $value));
     }
 
-    /**
-     * @return $this
-     */
-    public function addParameterizedHeader(string $name, string $value, array $params = []): self
+    public function addParameterizedHeader(string $name, string $value, array $params = []): static
     {
         return $this->add(new ParameterizedHeader($name, $value, $params));
     }
 
-    /**
-     * @return $this
-     */
-    public function addHeader(string $name, mixed $argument, array $more = []): self
+    public function addHeader(string $name, mixed $argument, array $more = []): static
     {
         $parts = explode('\\', self::HEADER_CLASS_MAP[strtolower($name)] ?? UnstructuredHeader::class);
         $method = 'add'.ucfirst(array_pop($parts));
@@ -153,10 +130,7 @@ public function has(string $name): bool
         return isset($this->headers[strtolower($name)]);
     }
 
-    /**
-     * @return $this
-     */
-    public function add(HeaderInterface $header): self
+    public function add(HeaderInterface $header): static
     {
         self::checkHeaderClass($header);