🎨 Add missing types

roots · Dec 21, 2023 · f07d89a · f07d89a
1 parent 58c827e
commit f07d89a
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 56 deletions.
diff --git a/src/Contracts/Module.php b/src/Contracts/Module.php
@@ -6,8 +6,6 @@ interface Module
 {
     /**
      * Handle the module.
-     *
-     * @return array
      */
-    public function handle();
+    public function handle(): void;
 }
diff --git a/src/Document.php b/src/Document.php
@@ -12,25 +12,20 @@ class Document
 {
     /**
      * The DOMDocument instance.
-     *
-     * @var DOMDocument
      */
-    protected $document;
+    protected DOMDocument $document;
 
     /**
      * The XML encoding tag.
-     *
-     * @var string
      */
-    protected $encoding = '<?xml encoding="UTF-8">';
+    protected string $encoding = '<?xml encoding="UTF-8">';
 
     /**
      * Create a new DOM instance.
      *
-     * @param  string  $html
      * @return void
      */
-    public function __construct($html)
+    public function __construct(string $html)
     {
         $this->document = new DOMDocument();
 
@@ -46,10 +41,8 @@ public function __construct($html)
 
     /**
      * Make a new DOM instance.
-     *
-     * @param  string  $html
      */
-    public static function make($html): self
+    public static function make(string $html): self
     {
         return new static($html);
     }
@@ -86,23 +79,16 @@ public function html(): string
 
     /**
      * Call methods on the root document.
-     *
-     * @param  string  $name
-     * @param  array  $arguments
-     * @return mixed
      */
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments): mixed
     {
         return $this->document->{$name}(...$arguments);
     }
 
     /**
      * Get properties from the root document.
-     *
-     * @param  string  $name
-     * @return mixed
      */
-    public function __get($name)
+    public function __get(string $name): mixed
     {
         return $this->document->{$name};
     }

diff --git a/src/Modules/CleanUpModule.php b/src/Modules/CleanUpModule.php
@@ -3,10 +3,9 @@
 namespace Roots\AcornPretty\Modules;
 
 use Illuminate\Support\Str;
-use Roots\AcornPretty\Contracts\Module;
 use Roots\AcornPretty\Document;
 
-class CleanUpModule extends AbstractModule implements Module
+class CleanUpModule extends AbstractModule
 {
     /**
      * The module key.
@@ -147,10 +146,8 @@ protected function handleDisableExtraRss(): self
 
     /**
      * Disable recent comments CSS.
-     *
-     * @return self
      */
-    protected function handleDisableRecentCommentsCss()
+    protected function handleDisableRecentCommentsCss(): self
     {
         if (! $this->config->get('disable-recent-comments-css')) {
             return $this;
@@ -205,12 +202,8 @@ public function cleanScriptTags(string $html): string
 
     /**
      * Add and remove body_class() classes.
-     *
-     * @param  array  $classes
-     * @param  array  $disallowedClasses
-     * @return array
      */
-    public function bodyClass($classes, $disallowedClasses = ['page-template-default'])
+    public function bodyClass(array $classes, array $disallowedClasses = ['page-template-default']): array
     {
         if (is_single() || is_page() && ! is_front_page()) {
             if (! in_array($slug = basename(get_permalink()), $classes, true)) {
@@ -230,10 +223,8 @@ public function bodyClass($classes, $disallowedClasses = ['page-template-default
 
     /**
      * Clean up language_attributes() used in <html> tag.
-     *
-     * @return string
      */
-    public function languageAttributes()
+    public function languageAttributes(): string
     {
         $attributes = [];
 
@@ -252,11 +243,8 @@ public function languageAttributes()
 
     /**
      * Remove self-closing tags.
-     *
-     * @param  string|string[]  $html
-     * @return string|string[]
      */
-    public function removeSelfClosingTags($html)
+    public function removeSelfClosingTags(string|array $html): string|array
     {
         return str_replace(' />', '>', $html);
     }

diff --git a/src/Modules/NiceSearchModule.php b/src/Modules/NiceSearchModule.php
@@ -2,9 +2,7 @@
 
 namespace Roots\AcornPretty\Modules;
 
-use Roots\AcornPretty\Contracts\Module;
-
-class NiceSearchModule extends AbstractModule implements Module
+class NiceSearchModule extends AbstractModule
 {
     /**
      * The module key.

diff --git a/src/Modules/RelativeUrlsModule.php b/src/Modules/RelativeUrlsModule.php
@@ -3,9 +3,8 @@
 namespace Roots\AcornPretty\Modules;
 
 use Illuminate\Support\Str;
-use Roots\AcornPretty\Contracts\Module;
 
-class RelativeUrlsModule extends AbstractModule implements Module
+class RelativeUrlsModule extends AbstractModule
 {
     /**
      * The module key.
@@ -40,11 +39,8 @@ public function handle(): void
 
     /**
      * Convert an absolute URL to a relative URL.
-     *
-     * @param  string  $url
-     * @return string
      */
-    public function relativeUrl($url)
+    public function relativeUrl(string $url): string
     {
         if (is_feed()) {
             return $url;
@@ -63,7 +59,7 @@ public function relativeUrl($url)
      * @param  string[]  $sources
      * @return string[]
      */
-    public function imageSrcset($sources)
+    public function imageSrcset(string|array $sources): string|array
     {
         if (! is_array($sources)) {
             return $sources;
@@ -107,13 +103,8 @@ protected function handleSeoFramework(): self
 
     /**
      * Determine if two URLs contain the same base URL.
-     *
-     * @param  string  $baseUrl
-     * @param  string  $inputUrl
-     * @param  bool  $strict
-     * @return bool
      */
-    protected function compareBaseUrl($baseUrl, $inputUrl, $strict = true)
+    protected function compareBaseUrl(string $baseUrl, string $inputUrl, bool $strict = true): bool
     {
         $baseUrl = trailingslashit($baseUrl);
         $inputUrl = trailingslashit($inputUrl);