CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v3.0.0...master)
+[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v3.1.0...master)
 --------------
 
 ### Fixed
@@ -11,6 +11,20 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+2024-07-12, 3.1.0
+------------------
+
+### Fixed
+- Fix return value of query scopes from parent class [#1366 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1366)
+- Add static to isBuiltin() check in ide-helper:models [#1541 / bram-pkg](https://github.com/barryvdh/laravel-ide-helper/pull/1541)
+- Fix for getSomethingAttribute functions which return a collection with type templating in the phpDoc. [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
+
+### Added
+ - Add type to pivot when using a custom pivot class [#1518 / d3v2a](https://github.com/barryvdh/laravel-ide-helper/pull/1518)
+ - Add support in morphTo relationship for null values [#1547 / matysekmichal](https://github.com/barryvdh/laravel-ide-helper/pull/1547)
+ - Add support for AsEnumCollection casts [#1557 / Braunson](https://github.com/barryvdh/laravel-ide-helper/pull/1557)
+ - Support for Attribute class in attributes [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
+
 2024-03-01, 3.0.0
 ------------------
 
@@ -22,7 +36,7 @@ All notable changes to this project will be documented in this file.
 - Use short types (`int` and `bool` instead of `integer` and `boolean`) [#1524 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1524)
 
 ### Removed
-- Support for Laravel 9 and use of doctrine/dbal [#1512 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1512) 
+- Support for Laravel 9 and use of doctrine/dbal [#1512 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1512)
   With this functionality gone, a few changes have been made:
   - support for custom datatypes has been dropped (config `custom_db_types`) unknown data types default to `string` now and to fix the type, add a proper cast in Eloquent
   - You _might_ have top-level dependency on doctrine/dbal. This may have been in the past due to ide-helper, we suggest to check if you still need it and remove it otherwise
@@ -86,7 +100,7 @@ All notable changes to this project will be documented in this file.
 - Handle PHP 8.1 deprecation warnings when passing `null` to `new \ReflectionClass` [#1351 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1351)
 - Fix issue where \Eloquent is not included when using write_mixin [#1352 / Jefemy](https://github.com/barryvdh/laravel-ide-helper/pull/1352)
 - Fix model factory method arguments for Laravel >= 9 [#1361 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1361)
-- Improve return type of mock helper methods in tests [#1405 / bentleyo](https://github.com/barryvdh/laravel-ide-helper/pull/1405) 
+- Improve return type of mock helper methods in tests [#1405 / bentleyo](https://github.com/barryvdh/laravel-ide-helper/pull/1405)
 - Fix Castable class if failed to detect it from return types [#1388 / kwarcu](https://github.com/barryvdh/laravel-ide-helper/pull/1388)
 
 ### Added

composer.json

@@ -65,7 +65,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.0-dev"
+            "dev-master": "3.1-dev"
         },
         "laravel": {
             "providers": [

config/ide-helper.php

@@ -4,29 +4,29 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Filename & Format
+    | Filename
     |--------------------------------------------------------------------------
     |
-    | The default filename
+    | The default filename.
     |
     */
 
-    'filename'  => '_ide_helper.php',
+    'filename' => '_ide_helper.php',
 
     /*
     |--------------------------------------------------------------------------
     | Models filename
     |--------------------------------------------------------------------------
     |
-    | The default filename for the models helper file
+    | The default filename for the models helper file.
     |
     */
 
     'models_filename' => '_ide_helper_models.php',
 
     /*
     |--------------------------------------------------------------------------
-    | Where to write the PhpStorm specific meta file
+    | PhpStorm meta filename
     |--------------------------------------------------------------------------
     |
     | PhpStorm also supports the directory `.phpstorm.meta.php/` with arbitrary
@@ -41,15 +41,15 @@
     | Fluent helpers
     |--------------------------------------------------------------------------
     |
-    | Set to true to generate commonly used Fluent methods
+    | Set to true to generate commonly used Fluent methods.
     |
     */
 
     'include_fluent' => false,
 
     /*
     |--------------------------------------------------------------------------
-    | Factory Builders
+    | Factory builders
     |--------------------------------------------------------------------------
     |
     | Set to true to generate factory generators for better factory()
@@ -63,29 +63,29 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Write Model Magic methods
+    | Write model magic methods
     |--------------------------------------------------------------------------
     |
-    | Set to false to disable write magic methods of model
+    | Set to false to disable write magic methods of model.
     |
     */
 
     'write_model_magic_where' => true,
 
     /*
     |--------------------------------------------------------------------------
-    | Write Model External Eloquent Builder methods
+    | Write model external Eloquent builder methods
     |--------------------------------------------------------------------------
     |
-    | Set to false to disable write external eloquent builder methods
+    | Set to false to disable write external Eloquent builder methods.
     |
     */
 
     'write_model_external_builder_methods' => true,
 
     /*
     |--------------------------------------------------------------------------
-    | Write Model relation count properties
+    | Write model relation count properties
     |--------------------------------------------------------------------------
     |
     | Set to false to disable writing of relation count properties to model DocBlocks.
@@ -96,11 +96,11 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Write Eloquent Model Mixins
+    | Write Eloquent model mixins
     |--------------------------------------------------------------------------
     |
     | This will add the necessary DocBlock mixins to the model class
-    | contained in the Laravel Framework. This helps the IDE with
+    | contained in the Laravel framework. This helps the IDE with
     | auto-completion.
     |
     | Please be aware that this setting changes a file within the /vendor directory.
@@ -134,7 +134,7 @@
     | for models.
     |
     | glob patterns are supported to easier reach models in sub-directories,
-    | e.g. `app/Services/* /Models` (without the space)
+    | e.g. `app/Services/* /Models` (without the space).
     |
     */
 
@@ -152,15 +152,15 @@
     */
 
     'ignored_models' => [
-
+        // App\MyModel::class,
     ],
 
     /*
     |--------------------------------------------------------------------------
     | Models hooks
     |--------------------------------------------------------------------------
     |
-    | Define which hook classes you want to run for models to add custom information
+    | Define which hook classes you want to run for models to add custom information.
     |
     | Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface.
     |
@@ -175,7 +175,7 @@
     | Extra classes
     |--------------------------------------------------------------------------
     |
-    | These implementations are not really extended, but called with magic functions
+    | These implementations are not really extended, but called with magic functions.
     |
     */
 
@@ -197,7 +197,7 @@
     */
 
     'interfaces' => [
-
+        // App\MyInterface::class => App\MyImplementation::class,
     ],
 
     /*
@@ -228,7 +228,7 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Property Casts
+    | Property casts
     |--------------------------------------------------------------------------
     |
     | Cast the given "real type" to the given "type".
@@ -255,9 +255,9 @@
     | Force FQN usage
     |--------------------------------------------------------------------------
     |
-    | Use the fully qualified (class) name in docBlock,
-    | event if class exists in a given file
-    | or there is an import (use className) of a given class
+    | Use the fully qualified (class) name in DocBlocks,
+    | even if the class exists in the same namespace
+    | or there is an import (use className) of the class.
     |
     */
     'force_fqn' => false,
@@ -279,8 +279,8 @@
     |--------------------------------------------------------------------------
     |
     | Sometimes it's needed to create custom relation types. The key of the array
-    | is the Relationship Method name. The value of the array is the canonical class
-    | name of the Relationship, e.g. `'relationName' => RelationShipClass::class`.
+    | is the relationship method name. The value of the array is the fully-qualified
+    | class name of the relationship, e.g. `'relationName' => RelationShipClass::class`.
     |
     */
     'additional_relation_types' => [],