fix: Explicit nullable type

Issue #1461
moonshine-software · Jan 9, 2025 · 5d4eef0 · 5d4eef0
1 parent 4d95bcc
commit 5d4eef0
Show file tree

Hide file tree

Showing 30 changed files with 45 additions and 42 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -14,6 +14,7 @@
     ->setRules([
         '@PSR12' => true,
         'native_function_invocation' => true,
+        'nullable_type_declaration_for_default_null_value' => true,
         'array_syntax' => ['syntax' => 'short'],
         'ordered_imports' => ['sort_algorithm' => 'alpha'],
         'no_unused_imports' => true,

diff --git a/rector.php b/rector.php
@@ -36,6 +36,8 @@
     $rectorConfig->importShortClasses();
     $rectorConfig->removeUnusedImports();
 
+    $rectorConfig->rule(Rector\Php84\Rector\Param\ExplicitNullableParamTypeRector::class);
+
     $rectorConfig->sets([
         LevelSetList::UP_TO_PHP_82,
         SetList::CODE_QUALITY,

diff --git a/src/Contracts/src/Core/CrudResourceContract.php b/src/Contracts/src/Core/CrudResourceContract.php
@@ -22,7 +22,7 @@
 interface CrudResourceContract extends ResourceContract
 {
     public function getRoute(
-        string $name = null,
+        ?string $name = null,
         DataWrapperContract|int|string|null $key = null,
         array $query = []
     ): string;

diff --git a/src/Contracts/src/Core/DependencyInjection/FieldsContract.php b/src/Contracts/src/Core/DependencyInjection/FieldsContract.php
@@ -58,7 +58,7 @@ public function whenFieldsConditions(): static;
      */
     public function findByColumn(
         string $column,
-        FieldContract $default = null
+        ?FieldContract $default = null
     ): ?FieldContract;
 
     /**
@@ -69,7 +69,7 @@ public function findByColumn(
      */
     public function findByClass(
         string $class,
-        FieldContract $default = null
+        ?FieldContract $default = null
     ): ?FieldContract;
 
     public function wrapNames(string $name): static;

diff --git a/src/Contracts/src/Core/PagesContract.php b/src/Contracts/src/Core/PagesContract.php
@@ -25,7 +25,7 @@ interface PagesContract extends Enumerable
      */
     public function findByType(
         PageType $type,
-        PageContract $default = null
+        ?PageContract $default = null
     ): ?PageContract;
 
     /**
@@ -37,7 +37,7 @@ public function findByType(
      */
     public function findByClass(
         string $class,
-        PageContract $default = null
+        ?PageContract $default = null
     ): ?PageContract;
 
     /**
@@ -46,7 +46,7 @@ public function findByClass(
      */
     public function findByUri(
         string $uri,
-        PageContract $default = null
+        ?PageContract $default = null
     ): ?PageContract;
 
     public function activePage(): ?PageContract;

diff --git a/src/Contracts/src/Core/ResourcesContract.php b/src/Contracts/src/Core/ResourcesContract.php
@@ -25,7 +25,7 @@ interface ResourcesContract extends Enumerable
      */
     public function findByUri(
         string $uri,
-        ResourceContract $default = null
+        ?ResourceContract $default = null
     ): ?ResourceContract;
 
     /**
@@ -35,6 +35,6 @@ public function findByUri(
      */
     public function findByClass(
         string $class,
-        ResourceContract $default = null
+        ?ResourceContract $default = null
     ): ?ResourceContract;
 }
diff --git a/src/Contracts/src/UI/Collection/ComponentsContract.php b/src/Contracts/src/UI/Collection/ComponentsContract.php
@@ -40,16 +40,16 @@ public function onlyComponents(): static;
 
     public function findForm(
         string $name,
-        FormBuilderContract $default = null
+        ?FormBuilderContract $default = null
     ): ?FormBuilderContract;
 
     public function findTable(
         string $name,
-        TableBuilderContract $default = null
+        ?TableBuilderContract $default = null
     ): ?TableBuilderContract;
 
     public function findByName(
         string $name,
-        ComponentContract $default = null
+        ?ComponentContract $default = null
     ): ?ComponentContract;
 }
diff --git a/src/Contracts/src/UI/FormElementContract.php b/src/Contracts/src/UI/FormElementContract.php
@@ -23,7 +23,7 @@ public function setParent(FormElementContract $field): static;
 
     public function formName(?string $formName = null): static;
 
-    public function getIdentity(string $index = null): string;
+    public function getIdentity(?string $index = null): string;
 
     public function getFormName(): ?string;
 
@@ -69,7 +69,7 @@ public function getDefaultIfExists(): mixed;
 
     public function getRowIndex(): int;
 
-    public function getNameAttribute(string $index = null): string;
+    public function getNameAttribute(?string $index = null): string;
 
     public function customWrapperAttributes(array $attributes): static;
 

diff --git a/src/Contracts/src/UI/HasQuickFormElementAttributesContract.php b/src/Contracts/src/UI/HasQuickFormElementAttributesContract.php
@@ -10,7 +10,7 @@ interface HasQuickFormElementAttributesContract
 {
     public function setNameAttribute(string $name): static;
 
-    public function getNameAttribute(string $index = null): string;
+    public function getNameAttribute(?string $index = null): string;
 
     public function wrapName(string $wrapName): static;
 

diff --git a/src/Core/src/Collections/Components.php b/src/Core/src/Collections/Components.php
@@ -100,7 +100,7 @@ public function onlyFields(bool $withWrappers = false): FieldsContract
      */
     public function findForm(
         string $name,
-        FormBuilderContract $default = null
+        ?FormBuilderContract $default = null
     ): ?FormBuilderContract {
         return $this->onlyForms()->first(
             static fn (FormBuilderContract $component): bool => $component->getName() === $name,
@@ -113,7 +113,7 @@ public function findForm(
      */
     public function findTable(
         string $name,
-        TableBuilderContract $default = null
+        ?TableBuilderContract $default = null
     ): ?TableBuilderContract {
         return $this->onlyTables()->first(
             static fn (TableBuilderContract $component): bool => $component->getName() === $name,
@@ -126,7 +126,7 @@ public function findTable(
      */
     public function findByName(
         string $name,
-        ComponentContract $default = null
+        ?ComponentContract $default = null
     ): ?ComponentContract {
         return $this->onlyComponents()->first(
             static fn (ComponentContract $component): bool => $component->getName() === $name,

diff --git a/src/Core/src/Pages/Pages.php b/src/Core/src/Pages/Pages.php
@@ -24,14 +24,14 @@ public function setResource(ResourceContract $resource): Pages
 
     public function findByType(
         PageType $type,
-        PageContract $default = null
+        ?PageContract $default = null
     ): ?PageContract {
         return $this->first(static fn (PageContract $page): bool => $page->getPageType() === $type, $default);
     }
 
     public function findByClass(
         string $class,
-        PageContract $default = null
+        ?PageContract $default = null
     ): ?PageContract {
         return $this->first(
             static fn (PageContract $page): bool => $page::class === $class,
@@ -61,7 +61,7 @@ public function activePage(): ?PageContract
 
     public function findByUri(
         string $uri,
-        PageContract $default = null
+        ?PageContract $default = null
     ): ?PageContract {
         return $this->first(
             static function (PageContract $page) use ($uri): bool {

diff --git a/src/Core/src/Resources/Resources.php b/src/Core/src/Resources/Resources.php
@@ -12,7 +12,7 @@ final class Resources extends Collection implements ResourcesContract
 {
     public function findByUri(
         string $uri,
-        ResourceContract $default = null
+        ?ResourceContract $default = null
     ): ?ResourceContract {
         return $this->first(
             static fn (ResourceContract $resource): bool => $resource->getUriKey() === $uri,
@@ -22,7 +22,7 @@ public function findByUri(
 
     public function findByClass(
         string $class,
-        ResourceContract $default = null
+        ?ResourceContract $default = null
     ): ?ResourceContract {
         return $this->first(
             static fn (ResourceContract $resource): bool => $resource::class === $class,

diff --git a/src/Core/src/Storage/FileStorage.php b/src/Core/src/Storage/FileStorage.php
@@ -56,15 +56,15 @@ public function storeAs(string $path, mixed $file, $name = null, array $options
         return $this->store($path, $file, $options);
     }
 
-    public function getFiles(string $directory = null, bool $recursive = false): array
+    public function getFiles(?string $directory = null, bool $recursive = false): array
     {
         return iterator_to_array(
             Finder::create()->files()->in($directory)->depth(0)->sortByName(),
             false
         );
     }
 
-    public function getDirectories(string $directory = null, bool $recursive = false): array
+    public function getDirectories(?string $directory = null, bool $recursive = false): array
     {
         $directories = [];
 

diff --git a/src/Laravel/src/Buttons/MassDeleteButton.php b/src/Laravel/src/Buttons/MassDeleteButton.php
@@ -16,7 +16,7 @@ final class MassDeleteButton
 {
     public static function for(
         CrudResource $resource,
-        string $componentName = null,
+        ?string $componentName = null,
         ?string $redirectAfterDelete = null,
         bool $isAsync = true,
         string $modalName = 'resource-mass-delete-modal',

diff --git a/src/Laravel/src/Collections/Fields.php b/src/Laravel/src/Collections/Fields.php
@@ -98,7 +98,7 @@ public function detailFields(bool $withOutside = false, bool $onlyOutside = fals
      */
     public function findByRelation(
         string $relation,
-        ModelRelationField $default = null
+        ?ModelRelationField $default = null
     ): ?ModelRelationField {
         return $this->onlyRelationFields()->first(
             static fn (ModelRelationField $field): bool => $field->getRelationName() === $relation,

diff --git a/src/Laravel/src/Contracts/Fields/HasAsyncSearchContract.php b/src/Laravel/src/Contracts/Fields/HasAsyncSearchContract.php
@@ -19,7 +19,7 @@ public function getAsyncSearchCount(): int;
     public function getAsyncSearchValueCallback(): ?Closure;
 
     public function asyncSearch(
-        string $column = null,
+        ?string $column = null,
         ?Closure $searchQuery = null,
         ?Closure $formatted = null,
         ?string $associatedWith = null,

diff --git a/src/Laravel/src/DependencyInjection/MoonShineConfigurator.php b/src/Laravel/src/DependencyInjection/MoonShineConfigurator.php
@@ -244,7 +244,7 @@ public function getGuard(): string
         return $this->get('auth.guard', 'moonshine');
     }
 
-    public function getUserField(string $field, string $default = null): string|false
+    public function getUserField(string $field, ?string $default = null): string|false
     {
         return $this->get("user_fields.$field", $default ?? $field);
     }

diff --git a/src/Laravel/src/Handlers/Handlers.php b/src/Laravel/src/Handlers/Handlers.php
@@ -16,7 +16,7 @@ final class Handlers extends Collection
 {
     public function findByUri(
         string $uri,
-        Handler $default = null
+        ?Handler $default = null
     ): ?Handler {
         return $this->first(
             static fn (Handler $handler): bool => $handler->getUriKey() === $uri,

diff --git a/src/Laravel/src/Http/Controllers/MoonShineController.php b/src/Laravel/src/Http/Controllers/MoonShineController.php
@@ -33,7 +33,7 @@ public function __construct(
     protected function json(
         string $message = '',
         array $data = [],
-        string $redirect = null,
+        ?string $redirect = null,
         ToastType $messageType = ToastType::SUCCESS,
         int $status = Response::HTTP_OK
     ): JsonResponse {

diff --git a/src/Laravel/src/Storage/LaravelStorage.php b/src/Laravel/src/Storage/LaravelStorage.php
@@ -54,7 +54,7 @@ public function getFiles(string $directory, bool $recursive = false): array
         return $this->filesystem->files($directory, $recursive);
     }
 
-    public function getDirectories(string $directory = null, bool $recursive = false): array
+    public function getDirectories(?string $directory = null, bool $recursive = false): array
     {
         return $this->filesystem->directories($directory, $recursive);
     }

diff --git a/src/Laravel/src/Traits/Fields/WithAsyncSearch.php b/src/Laravel/src/Traits/Fields/WithAsyncSearch.php
@@ -164,7 +164,7 @@ public function getAsyncSearchOption(Model $model, ?string $searchColumn = null)
      * @param  ?Closure(mixed $data, FieldContract $field): static  $formatted
      */
     public function asyncSearch(
-        string $column = null,
+        ?string $column = null,
         ?Closure $searchQuery = null,
         ?Closure $formatted = null,
         ?string $associatedWith = null,

diff --git a/src/Laravel/src/Traits/Resource/ResourceCrudRouter.php b/src/Laravel/src/Traits/Resource/ResourceCrudRouter.php
@@ -21,7 +21,7 @@ trait ResourceCrudRouter
      * @param DataWrapperContract<T>|int|string|null $key
      */
     public function getRoute(
-        string $name = null,
+        ?string $name = null,
         DataWrapperContract|int|string|null $key = null,
         array $query = []
     ): string {

diff --git a/src/MenuManager/src/MenuGroup.php b/src/MenuManager/src/MenuGroup.php
@@ -17,7 +17,7 @@ class MenuGroup extends MenuElement
     public function __construct(
         Closure|string $label,
         protected iterable $items = [],
-        string $icon = null,
+        ?string $icon = null,
     ) {
         parent::__construct();
 

diff --git a/src/MenuManager/src/MenuItem.php b/src/MenuManager/src/MenuItem.php
@@ -33,7 +33,7 @@ class MenuItem extends MenuElement
     final public function __construct(
         Closure|string $label,
         protected Closure|MenuFillerContract|string $filler,
-        string $icon = null,
+        ?string $icon = null,
         Closure|bool $blank = false
     ) {
         parent::__construct();

diff --git a/src/UI/src/Collections/Fields.php b/src/UI/src/Collections/Fields.php
@@ -318,7 +318,7 @@ public function extractLabels(): array
      */
     public function findByColumn(
         string $column,
-        FieldContract $default = null
+        ?FieldContract $default = null
     ): ?FieldContract {
         return $this->first(
             static fn (FieldContract $field): bool => $field->getColumn() === $column,
@@ -328,7 +328,7 @@ public function findByColumn(
 
     public function findByClass(
         string $class,
-        FieldContract $default = null
+        ?FieldContract $default = null
     ): ?FieldContract {
         return $this->first(
             static fn (FieldContract $field): bool => $field::class === $class,

diff --git a/src/UI/src/Fields/FormElement.php b/src/UI/src/Fields/FormElement.php
@@ -150,7 +150,7 @@ public function setParent(FormElementContract $field): static
         return $this;
     }
 
-    public function getIdentity(string $index = null): string
+    public function getIdentity(?string $index = null): string
     {
         return (string) str($this->getNameAttribute($index))
             ->replace(['[', ']'], '_')

diff --git a/src/UI/src/Traits/Fields/WithQuickFormElementAttributes.php b/src/UI/src/Traits/Fields/WithQuickFormElementAttributes.php
@@ -25,7 +25,7 @@ public function setNameAttribute(string $name): static
         return $this;
     }
 
-    public function getNameAttribute(string $index = null): string
+    public function getNameAttribute(?string $index = null): string
     {
         return $this->prepareNameAttribute($index);
     }

diff --git a/tests/Expectations.php b/tests/Expectations.php
@@ -14,6 +14,6 @@
         ->toBe(['onAfterDestroy']);
 });
 
-expect()->extend('hasFields', fn (array $fields = null) => expect($this->value)
+expect()->extend('hasFields', fn (?array $fields = null) => expect($this->value)
     ->toBeCollection()
     ->toHaveCount($fields ? \count($fields) : 0));
diff --git a/tests/Feature/ComponentsEqualsTest.php b/tests/Feature/ComponentsEqualsTest.php
@@ -76,7 +76,7 @@ function compare(
     array $parameters = [],
     array $attributes = [],
     string $slot = '',
-    string $alias = null
+    ?string $alias = null
 ): void {
     if ($attributes === []) {
         $attributes = [

diff --git a/tests/Fixtures/Resources/TestResourceBuilder.php b/tests/Fixtures/Resources/TestResourceBuilder.php
@@ -15,7 +15,7 @@
 
 class TestResourceBuilder
 {
-    public static function new(string $model = null): TestResource
+    public static function new(?string $model = null): TestResource
     {
         $resource = app(TestResource::class);