Feature/phpstan level

.php-cs-fixer.cache

@@ -1 +1 @@
-{"php":"8.1.8","version":"3.9.5","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"blank_line_between_import_groups":true,"braces":{"allow_single_line_anonymous_class_with_empty_body":true},"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_import_per_statement":{"group_to_single_imports":false},"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"class_attributes_separation":{"elements":{"method":"one"}}},"hashes":{"src\/Components\/Components.php":4113470597,"src\/ValueObjects\/Types.php":976112391,"src\/Fields\/Image.php":3475913326,"src\/Fields\/Text.php":1843933408,"src\/Fields\/Fields.php":3082770791,"src\/Fields\/Boolean.php":288662375,"src\/Fields\/Tabs.php":2338077135,"src\/Fields\/Select.php":2468598124,"src\/Fields\/Tab.php":122323775,"src\/Fields\/MultiSelect.php":2967987406,"src\/Fields\/Number.php":2972592454,"src\/Contracts\/Field.php":3529337728,"src\/Contracts\/Route.php":1966485194,"src\/Contracts\/IndexComponents.php":1435574258,"src\/Contracts\/Invokables.php":1570910920,"src\/Contracts\/Filter.php":1482797957,"src\/Contracts\/Header.php":3412176535,"src\/Contracts\/FormComponents.php":2006127091,"src\/Contracts\/ComponentsInterface.php":39333525,"src\/Contracts\/Component.php":4154481113,"src\/Contracts\/Renderer.php":3899250064,"src\/Services\/CreateCustomService.php":2751149137,"src\/Services\/FilterService.php":1136423926,"src\/Services\/SortingService.php":971942833,"src\/BreadServiceProvider.php":3682323247,"src\/Routes\/Destroy.php":392466729,"src\/Routes\/Create.php":3261679531,"src\/Routes\/Index.php":2467093646,"src\/Routes\/Edit.php":3380151641,"src\/Routes\/Store.php":901166628,"src\/Routes\/Routes.php":1567158451,"src\/Routes\/Update.php":1183005567,"src\/Filters\/Text.php":4047841771,"src\/Filters\/Filter.php":1453482139,"src\/Filters\/Boolean.php":1579975008,"src\/Filters\/Filters.php":3143774296,"src\/Filters\/Select.php":412827139,"src\/Headers\/Date.php":801899764,"src\/Headers\/Text.php":1963652945,"src\/Headers\/Headers.php":3282279307,"src\/Headers\/Boolean.php":3260714470,"src\/Headers\/Trend.php":1947377138,"src\/Headers\/Link.php":3399789503,"src\/Headers\/Set.php":186843820,"src\/Headers\/Money.php":3303539918,"src\/Headers\/Download.php":2796001948,"src\/Headers\/Rating.php":1094539246,"src\/Headers\/Label.php":3381470344,"src\/Headers\/InertiaLink.php":3761921318,"src\/Headers\/Number.php":844704962,"src\/Commands\/CreateCustomField.php":1830559918,"src\/Commands\/CreateCustomHeader.php":1362670939,"src\/Commands\/CreateCustomFilter.php":2772280546,"src\/Renderers\/FormRenderer.php":119095043,"src\/Renderers\/IndexRenderer.php":144237398,"tests\/Pest.php":1399058707,"tests\/TestCase.php":51090682}}
+{"php":"8.1.10","version":"3.11.0","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"blank_line_between_import_groups":true,"braces":{"allow_single_line_anonymous_class_with_empty_body":true},"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_import_per_statement":{"group_to_single_imports":false},"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"class_attributes_separation":{"elements":{"method":"one"}}},"hashes":{"src\/Services\/FilterService.php":3242563327,"src\/Services\/SortingService.php":570185584,"src\/Services\/CreateCustomService.php":3045546300,"src\/ValueObjects\/Types.php":976112391,"src\/BreadServiceProvider.php":3682323247,"src\/Contracts\/Component.php":413477820,"src\/Contracts\/Route.php":1994232514,"src\/Contracts\/Header.php":1729022448,"src\/Contracts\/Invokables.php":3589802302,"src\/Contracts\/FormComponents.php":2006127091,"src\/Contracts\/Renderer.php":2450971325,"src\/Contracts\/Field.php":4212146176,"src\/Contracts\/ComponentsInterface.php":957920066,"src\/Contracts\/IndexComponents.php":1435574258,"src\/Contracts\/Filter.php":2143273424,"src\/Routes\/Create.php":1695394094,"src\/Routes\/Destroy.php":1458008311,"src\/Routes\/Update.php":4166386385,"src\/Routes\/Store.php":460891973,"src\/Routes\/Routes.php":2675183373,"src\/Routes\/Index.php":2907359599,"src\/Routes\/Edit.php":3991995671,"src\/Filters\/Filters.php":3707575036,"src\/Filters\/Text.php":1721742153,"src\/Filters\/Boolean.php":1951698771,"src\/Filters\/Select.php":3820557334,"src\/Filters\/Filter.php":1213338388,"src\/Commands\/CreateCustomFilter.php":1671250702,"src\/Commands\/CreateCustomHeader.php":250823473,"src\/Commands\/CreateCustomField.php":4000417138,"src\/Renderers\/IndexRenderer.php":1195470683,"src\/Renderers\/FormRenderer.php":1601248856,"src\/Fields\/Number.php":124780854,"src\/Fields\/MultiSelect.php":2655589068,"src\/Fields\/Text.php":3296465271,"src\/Fields\/Image.php":4032533664,"src\/Fields\/Fields.php":3572158689,"src\/Fields\/Boolean.php":710075004,"src\/Fields\/Tab.php":3137926331,"src\/Fields\/Tabs.php":3422655071,"src\/Fields\/Select.php":2269241859,"src\/Headers\/Number.php":3468185039,"src\/Headers\/Text.php":3453491020,"src\/Headers\/Link.php":3708658392,"src\/Headers\/Money.php":1414716803,"src\/Headers\/Boolean.php":1436861502,"src\/Headers\/Date.php":791925921,"src\/Headers\/Label.php":2559479232,"src\/Headers\/Download.php":1670883268,"src\/Headers\/Headers.php":1828549759,"src\/Headers\/InertiaLink.php":3847878985,"src\/Headers\/Rating.php":2195370648,"src\/Headers\/Trend.php":3244001513,"src\/Headers\/Set.php":4116951602,"src\/Components\/Components.php":3025943152,"tests\/Pest.php":1399058707,"tests\/TestCase.php":51090682}}

phpstan.neon.dist

@@ -2,8 +2,9 @@ includes:
     - ./vendor/nunomaduro/larastan/extension.neon
 
 parameters:
-    level: 5
+    level: 9
     paths:
         - src
     tmpDir: build/phpstan
     checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false

src/Commands/CreateCustomField.php

@@ -15,6 +15,7 @@ class CreateCustomField extends Command
     public function handle(): int
     {
         $name = $this->argument('name');
+        $name = is_string($name) ? $name : '';
 
         if (! CreateCustomService::isNameValid($name)) {
             $this->error("Name: '$name' is not valid");

src/Commands/CreateCustomFilter.php

@@ -15,6 +15,7 @@ class CreateCustomFilter extends Command
     public function handle(): int
     {
         $name = $this->argument('name');
+        $name = is_string($name) ? $name : '';
 
         if (! CreateCustomService::isNameValid($name)) {
             $this->error("Name: '$name' is not valid");

src/Commands/CreateCustomHeader.php

@@ -15,6 +15,7 @@ class CreateCustomHeader extends Command
     public function handle(): int
     {
         $name = $this->argument('name');
+        $name = is_string($name) ? $name : '';
 
         if (! CreateCustomService::isNameValid($name)) {
             $this->error("Name: '$name' is not valid");

src/Components/Components.php

@@ -9,14 +9,17 @@
 
 final class Components
 {
+    /**
+     * @var Collection<int, Component>
+     */
     private Collection $components;
 
     public function __construct()
     {
         $this->components = new Collection();
     }
 
-    public static function add(...$components)
+    public static function add(Component ...$components): self
     {
         $class = new self();
 
@@ -27,7 +30,7 @@ public static function add(...$components)
         return $class;
     }
 
-    public function push(Component $component)
+    public function push(Component $component): self
     {
         $this->components->push($component);
 
@@ -39,14 +42,14 @@ public function get(): Collection
         return $this->components;
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return $this->components->map(function (Component $component) {
             return $component->toArray();
         })->toArray();
     }
 
-    public function getOptions()
+    public function getOptions(): array
     {
         return [];
     }

src/Contracts/Component.php

@@ -6,8 +6,14 @@
 
 abstract class Component
 {
+    /**
+     * @return string
+     */
     abstract public function getVue();
 
+    /**
+     * @return array
+     */
     public function toArray()
     {
         return [

src/Contracts/ComponentsInterface.php

@@ -6,9 +6,18 @@
 
 interface ComponentsInterface
 {
+    /**
+     * @return mixed
+     */
     public function header();
 
+    /**
+     * @return mixed
+     */
     public function aboveForm();
 
+    /**
+     * @return mixed
+     */
     public function belowForm();
 }

src/Contracts/Field.php

@@ -6,6 +6,7 @@
 
 abstract class Field
 {
+    /** @var string */
     public $type = 'text';
     public string $label = '';
     public string $name = '';
@@ -15,6 +16,9 @@ abstract class Field
             'mt-6',
         ],
     ];
+    /**
+     * @var mixed
+     */
     protected $options;
 
     public string $vueComponent;
@@ -34,7 +38,7 @@ public function __construct(string $name, string $label)
      * @param bool $overwrite
      * @return Field
      */
-    public function addWrapperClass($class, $overwrite = false)
+    public function addWrapperClass(string $class, $overwrite = false): Field
     {
         return $this->addClass('wrapper', $class, $overwrite);
     }
@@ -66,7 +70,7 @@ public function toArray()
         ];
     }
 
-    private function addClass(string $element, $class, $overwrite = false)
+    private function addClass(string $element, string $class, bool $overwrite = false): Field
     {
         if ($overwrite) {
             $this->classes[$element] = $class;

src/Contracts/Filter.php

@@ -27,7 +27,7 @@ public function __construct(string $label, string $field)
         $this->filterMethods = new Collection();
     }
 
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments): Filter
     {
         if (method_exists($this, $name)) {
             return $this->{$name}(...$arguments);
@@ -38,33 +38,38 @@ public function __call($name, $arguments)
         return $this;
     }
 
-    public function setLabel(string $label)
+    public function setLabel(string $label): Filter
     {
         $this->label = $label;
 
         return $this;
     }
 
-    public function setField(string $field)
+    public function setField(string $field): Filter
     {
         $this->field = $field;
 
         return $this;
     }
 
-    public function setType(string $type)
+    public function setType(string $type): Filter
     {
         $this->type = $type;
 
         return $this;
     }
 
-    public function setOption(string $key, $value)
+    /**
+     * @param string $key
+     * @param mixed $value
+     * @return void
+     */
+    public function setOption(string $key, $value): void
     {
         $this->options[$key] = $value;
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return [
             'label' => $this->label,
@@ -102,7 +107,7 @@ public function setOperator(string $operator): self
         return $this;
     }
 
-    public function apply(Builder $builder, $value)
+    public function apply(Builder $builder, mixed $value): Builder
     {
         return $builder->where($this->getField(), $this->getOperator(), $value);
     }
@@ -115,6 +120,9 @@ public function getFilterMethods(): Collection
         return $this->filterMethods;
     }
 
+    /**
+     * @return mixed
+     */
     private function getValue()
     {
         return app('request')->input("filters.{$this->getField()}");

src/Contracts/Header.php

@@ -6,12 +6,12 @@
 
 abstract class Header
 {
-    protected $value;
+    protected string $value;
     protected string $label;
 
     protected string $type = 'property';
 
-    protected $options = [];
+    protected array $options = [];
 
     protected bool $sortable = false;
     protected bool $editable = false;
@@ -22,20 +22,25 @@ public function __construct(string $label, string $value)
         $this->setValue($value);
     }
 
-    protected function setLabel(string $label)
+    protected function setLabel(string $label): self
     {
         $this->label = $label;
 
         return $this;
     }
 
-    protected function setValue($value)
+    protected function setValue(string $value): self
     {
         $this->value = $value;
 
         return $this;
     }
 
+    /**
+     * @param string $key
+     * @param mixed $value
+     * @return $this
+     */
     protected function setOption(string $key, $value): self
     {
         $this->options[$key] = $value;
@@ -54,28 +59,28 @@ protected function setType(string $type): Header
      * Available Options
      */
 
-    public function editable(bool $editable = false)
+    public function editable(bool $editable = false): self
     {
         $this->editable = $editable;
 
         return $this;
     }
 
-    public function sortable()
+    public function sortable(): self
     {
         $this->sortable = true;
 
         return $this;
     }
 
-    public function tooltip(string $tooltip)
+    public function tooltip(string $tooltip): self
     {
         $this->setOption('tooltip', $tooltip);
 
         return $this;
     }
 
-    public function toArray()
+    public function toArray(): array
     {
         return [
             'type' => $this->type,

src/Contracts/Invokables.php

@@ -6,5 +6,9 @@
 
 interface Invokables
 {
+    /**
+     * @param Renderer $renderer
+     * @return mixed
+     */
     public function __invoke(Renderer $renderer);
 }