Merge pull request #302 from hydephp/fix-types

Fix type issues hydephp/develop@529dea1

src/Actions/GeneratesDocumentationSearchIndexFile.php

@@ -47,7 +47,7 @@ public function execute(): void
         $this->save();
     }
 
-    public function generate(): self
+    public function generate(): static
     {
         foreach ($this->getSourceFileSlugs() as $page) {
             $this->searchIndex->push(
@@ -88,7 +88,7 @@ public function getJson(): string
         return json_encode($this->getObject());
     }
 
-    public function save(): self
+    public function save(): static
     {
         $this->needsDirectory(Hyde::path(str_replace('/search.json', '', static::$filePath)));
 

src/Commands/HydeBuildSearchCommand.php

@@ -74,7 +74,7 @@ protected function createSearchPage(): void
     /** @internal Estimated processing time per file in ms */
     public static float $guesstimationFactor = 52.5;
 
-    protected function guesstimateGenerationTime(): int
+    protected function guesstimateGenerationTime(): int|float
     {
         return (int) round(count(DiscoveryService::getDocumentationPageFiles()) * static::$guesstimationFactor) / 1000;
     }

src/Commands/HydePublishHomepageCommand.php

@@ -88,6 +88,6 @@ protected function canExistingIndexFileBeOverwritten(): bool
 
         return FileCacheService::checksumMatchesAny(FileCacheService::unixsumFile(
             Hyde::getBladePagePath('index.blade.php')
-        )) ?? $this->option('force');
+        )) || $this->option('force');
     }
 }

src/Commands/HydePublishViewsCommand.php

@@ -32,7 +32,7 @@ public function handle(): int
         return 0;
     }
 
-    protected function publishOption($selected)
+    protected function publishOption($selected): void
     {
         (new PublishesHydeViews($selected))->execute();
 

src/Concerns/HasPageMetadata.php

@@ -25,6 +25,11 @@ public function getCanonicalUrl(): string
         return $this->getRoute()->getQualifiedUrl();
     }
 
+    /**
+     * @return string[]
+     *
+     * @psalm-return list<string>
+     */
     public function getDynamicMetadata(): array
     {
         $array = [];

src/Concerns/Markdown/HasConfigurableMarkdownFeatures.php

@@ -15,7 +15,8 @@ trait HasConfigurableMarkdownFeatures
 {
     protected array $features = [];
 
-    public function addFeature(string $feature): self
+    /** @return $this */
+    public function addFeature(string $feature): static
     {
         if (! in_array($feature, $this->features)) {
             $this->features[] = $feature;
@@ -24,7 +25,8 @@ public function addFeature(string $feature): self
         return $this;
     }
 
-    public function removeFeature(string $feature): self
+    /** @return $this */
+    public function removeFeature(string $feature): static
     {
         if (in_array($feature, $this->features)) {
             $this->features = array_diff($this->features, [$feature]);
@@ -33,14 +35,16 @@ public function removeFeature(string $feature): self
         return $this;
     }
 
-    public function withTableOfContents(): self
+    /** @return $this */
+    public function withTableOfContents(): static
     {
         $this->addFeature('table-of-contents');
 
         return $this;
     }
 
-    public function withPermalinks(): self
+    /** @return $this */
+    public function withPermalinks(): static
     {
         $this->addFeature('permalinks');
 

src/Contracts/AbstractPage.php

@@ -66,7 +66,7 @@ public static function parse(string $slug): static
     }
 
     /** @inheritDoc */
-    public static function files(): array
+    public static function files(): array|false
     {
         return DiscoveryService::getSourceFileListForModel(static::class);
     }

src/Contracts/PageContract.php

@@ -54,11 +54,11 @@ public static function parse(string $slug): static;
      * Get an array of all the source file slugs for the model.
      * Essentially an alias of DiscoveryService::getAbstractPageList().
      *
-     * @return array<string>
+     * @return array<string>|false
      *
      * @see \Hyde\Framework\Testing\Unit\PageModelGetAllFilesHelperTest
      */
-    public static function files(): array;
+    public static function files(): array|false;
 
     /**
      * Get a collection of all pages, parsed into page models.

src/Facades/Asset.php

@@ -16,6 +16,7 @@
  */
 class Asset extends Facade
 {
+    /** @psalm-return AssetServiceContract::class */
     protected static function getFacadeAccessor(): string
     {
         return AssetServiceContract::class;

src/Foundation/Filesystem.php

@@ -73,7 +73,7 @@ public function vendorPath(string $path = ''): string
      * @param  bool  $force  If true, existing files will be overwritten.
      * @return bool|int Returns true|false on copy() success|failure, or an error code on failure
      */
-    public function copy(string $from, string $to, bool $force = false): bool|int
+    public function copy(string $from, string $to, bool $force = false): int|bool
     {
         if (! file_exists($from)) {
             return 404;

src/Hyde.php

@@ -48,12 +48,13 @@
  */
 class Hyde extends Facade
 {
+    /** @psalm-return HydeKernel::class */
     protected static function getFacadeAccessor(): string
     {
         return HydeKernel::class;
     }
 
-    public static function version()
+    public static function version(): string
     {
         return HydeKernel::version();
     }

src/Models/DocumentationSidebar.php

@@ -9,7 +9,8 @@
 
 class DocumentationSidebar extends NavigationMenu
 {
-    public function generate(): self
+    /** @return $this */
+    public function generate(): static
     {
         RoutingService::getInstance()->getRoutesForModel(DocumentationPage::class)->each(function (Route $route) {
             $this->items->push(NavItem::fromRoute($route)->setPriority($this->getPriorityForRoute($route)));

src/Models/Image.php

@@ -111,7 +111,7 @@ public function getContentLength(): int
         return (new FindsContentLengthForImageObject($this))->execute();
     }
 
-    public function getImageAuthorAttributionString(): ?string
+    public function getImageAuthorAttributionString(): string|null
     {
         if (isset($this->author)) {
             if (isset($this->credit)) {
@@ -124,7 +124,7 @@ public function getImageAuthorAttributionString(): ?string
         return null;
     }
 
-    public function getCopyrightString(): ?string
+    public function getCopyrightString(): string|null
     {
         if (isset($this->copyright)) {
             return '<span itemprop="copyrightNotice">'.e($this->copyright).'</span>';
@@ -133,7 +133,7 @@ public function getCopyrightString(): ?string
         return null;
     }
 
-    public function getLicenseString(): ?string
+    public function getLicenseString(): string|null
     {
         if (isset($this->license) && isset($this->licenseUrl)) {
             return '<a href="'.e($this->licenseUrl).'" rel="license nofollow noopener" itemprop="license">'.e($this->license).'</a>';

src/Models/NavigationMenu.php

@@ -25,7 +25,8 @@ public static function create(?RouteContract $currentRoute = null): static
         return (new static())->generate()->filter()->sort();
     }
 
-    public function generate(): self
+    /** @return $this */
+    public function generate(): static
     {
         RoutingService::getInstance()->getRoutes()->each(function (Route $route) {
             $this->items->push(NavItem::fromRoute($route));
@@ -38,15 +39,17 @@ public function generate(): self
         return $this;
     }
 
-    public function filter(): self
+    /** @return $this */
+    public function filter(): static
     {
         $this->items = $this->filterHiddenItems();
         $this->items = $this->filterDuplicateItems();
 
         return $this;
     }
 
-    public function sort(): self
+    /** @return $this */
+    public function sort(): static
     {
         $this->items = $this->items->sortBy('priority')->values();
 

src/Modules/DataCollections/DataCollection.php

@@ -30,7 +30,7 @@ public function __construct(string $key)
         parent::__construct();
     }
 
-    public function getCollection(): DataCollection
+    public function getCollection(): static
     {
         $this->parseTimeInMs = round((microtime(true) - $this->timeStart) * 1000, 2);
         unset($this->timeStart);

src/Modules/DataCollections/DataCollectionServiceProvider.php

@@ -21,7 +21,7 @@ public function register()
         );
     }
 
-    public function boot()
+    public function boot(): void
     {
         if (Features::hasDataCollections()) {
             // Create the _data directory if it doesn't exist

src/Services/BuildHookService.php

@@ -42,14 +42,14 @@ public function getPostBuildTasks(): array
         );
     }
 
-    public function run(string $task): self
+    public function run(string $task): static
     {
         $this->runTask(new $task($this->output));
 
         return $this;
     }
 
-    public function runIf(string $task, callable|bool $condition): self
+    public function runIf(string $task, callable|bool $condition): static
     {
         if (is_bool($condition) ? $condition : $condition()) {
             $this->run($task);
@@ -58,7 +58,7 @@ public function runIf(string $task, callable|bool $condition): self
         return $this;
     }
 
-    protected function runTask(BuildTaskContract $task): self
+    protected function runTask(BuildTaskContract $task): static
     {
         $task->handle();
 

src/Services/DiscoveryService.php

@@ -113,11 +113,9 @@ public static function createClickableFilepath(string $filepath): string
     }
 
     /**
-     * Get all the Markdown files in the _docs directory.
-     *
-     * @return array
+     *  Get all the Markdown files in the _docs directory.
      */
-    public static function getDocumentationPageFiles(): array
+    public static function getDocumentationPageFiles(): array|false
     {
         return self::getSourceFileListForModel(DocumentationPage::class);
     }
@@ -163,11 +161,10 @@ public static function formatSlugForModel(string $model, string $filepath): stri
     }
 
     /**
-     * Get all the Markdown files in the _pages directory.
-     *
      * @return array
+     *               Get all the Markdown files in the _pages directory.
      */
-    public static function getMarkdownPageFiles(): array
+    public static function getMarkdownPageFiles(): array|false
     {
         return self::getSourceFileListForModel(MarkdownPage::class);
     }
@@ -186,21 +183,19 @@ public static function getMediaAssetFiles(): array
     }
 
     /**
-     * Get all the Blade files in the _pages directory.
-     *
      * @return array
+     *               Get all the Blade files in the _pages directory.
      */
-    public static function getBladePageFiles(): array
+    public static function getBladePageFiles(): array|false
     {
         return self::getSourceFileListForModel(BladePage::class);
     }
 
     /**
-     * Get all the Markdown files in the _posts directory.
-     *
      * @return array
+     *               Get all the Markdown files in the _posts directory.
      */
-    public static function getMarkdownPostFiles(): array
+    public static function getMarkdownPostFiles(): array|false
     {
         return self::getSourceFileListForModel(MarkdownPost::class);
     }

src/Services/HydeSmartDocs.php

@@ -57,7 +57,7 @@ public function process(): self
         return $this;
     }
 
-    protected function tokenize(): self
+    protected function tokenize(): static
     {
         // The HTML content is expected to be two parts. To create semantic HTML,
         // we need to split the content into header and body. We do this by
@@ -73,7 +73,7 @@ protected function tokenize(): self
         return $this;
     }
 
-    protected function addDynamicHeaderContent(): self
+    protected function addDynamicHeaderContent(): static
     {
         // Hook to add dynamic content to the header.
         // This is where we can add TOC, breadcrumbs, etc.
@@ -85,7 +85,7 @@ protected function addDynamicHeaderContent(): self
         return $this;
     }
 
-    protected function addDynamicFooterContent(): self
+    protected function addDynamicFooterContent(): static
     {
         // Hook to add dynamic content to the footer.
         // This is where we can add copyright, attributions, info, etc.

src/Services/Markdown/BladeDownProcessor.php

@@ -48,7 +48,7 @@ public function __construct(string $html, ?array $pageData = [])
         $this->pageData = $pageData;
     }
 
-    public function run(): self
+    public function run(): static
     {
         $this->output = implode("\n", array_map(function ($line) {
             return $this->lineStartsWithDirective($line)

src/Services/Markdown/ShortcodeProcessor.php

@@ -47,7 +47,7 @@ public function __construct(string $input)
         $this->discoverShortcodes();
     }
 
-    public function processInput(): self
+    public function processInput(): static
     {
         $this->output = implode("\n", array_map(function ($line) {
             return $this->expandShortcode($line);
@@ -78,7 +78,7 @@ protected function discoverShortcodes(): void
         ));
     }
 
-    public function addShortcodesFromArray(array $shortcodes): self
+    public function addShortcodesFromArray(array $shortcodes): static
     {
         foreach ($shortcodes as $shortcode) {
             $this->addShortcode($shortcode);
@@ -87,7 +87,7 @@ public function addShortcodesFromArray(array $shortcodes): self
         return $this;
     }
 
-    public function addShortcode(MarkdownShortcodeContract $shortcode): self
+    public function addShortcode(MarkdownShortcodeContract $shortcode): static
     {
         $this->shortcodes[$shortcode::signature()] = $shortcode;
 

src/Services/RoutingService.php

@@ -91,15 +91,15 @@ public function addRoute(RouteContract $route): self
         return $this;
     }
 
-    protected function discover(PageContract $page): self
+    protected function discover(PageContract $page): static
     {
         // Create a new route for the given page, and add it to the index.
         $this->addRoute(new Route($page));
 
         return $this;
     }
 
-    protected function discoverRoutes(): self
+    protected function discoverRoutes(): static
     {
         $this->routes = new Collection();