-
-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3f30d20
commit 35784c4
Showing
98 changed files
with
1,159 additions
and
991 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| # Migration | ||
|
|
||
| This package comes with a very hands-off approach for migrations. If you check the new migrations published in `database/migrations`, you will find something very similar to this: | ||
|
|
||
| ```php | ||
| use Vendor\Package\Models\Car; | ||
|
|
||
| return Car::migration(); | ||
| ``` | ||
|
|
||
| Worry not, the migration will still work. It has been _simplified_ for easy customization. | ||
|
|
||
| ## Adding columns | ||
|
|
||
| To add columns to the migration, add a callback to the `migration()` method that receives the table blueprint. | ||
|
|
||
| ```php | ||
| use Illuminate\Database\Schema\Blueprint; | ||
| use Laragear\Package\Models\Car; | ||
|
|
||
| return Car::migration(function (Blueprint $table) { | ||
| $table->boolean('is_cool')->default(true); | ||
| $table->string('color'); | ||
| }); | ||
| ``` | ||
|
|
||
| > [!INFO] | ||
| > | ||
| > If your package doesn't support additional tables, the callback never executes. Refer to the package documentation. | ||
| ## After Up & Before Down | ||
|
|
||
| If you need to execute logic after creating the table, or before dropping it, use the `afterUp()` and `beforeDown()` methods, respectively. | ||
|
|
||
| ```php | ||
| use Illuminate\Database\Schema\Blueprint; | ||
| use Laragear\Package\Models\Car; | ||
|
|
||
| return Car::migration() | ||
| ->afterUp(function (Blueprint $table) { | ||
| $table->foreignId('sociable_id')->references('id')->on('users'); | ||
| }) | ||
| ->beforeDown(function (Blueprint $table) { | ||
| $table->dropForeign('sociable_id'); | ||
| }); | ||
| ``` | ||
|
|
||
| ### Morphs | ||
|
|
||
| You may find yourself needing to alter the type of the morph relation created in the migration. For example, the migration will create an integer-type morph that you won't be able to attach to an ULID-based User model. | ||
|
|
||
| To change the morph type, use the `morph...` property access preferably, or the `morph()` method with `numeric`, `uuid` or `ulid` if you need to also set an index name (in case your database engine doesn't play nice with large index names). | ||
|
|
||
| ```php | ||
| use Illuminate\Database\Schema\Blueprint; | ||
| use Laragear\Package\Models\Car; | ||
|
|
||
| return Car::migration()->morphUuid; | ||
|
|
||
| return Car::migration()->morph('uuid', 'shorter_morph_index_name'); | ||
| ``` | ||
|
|
||
| ## Custom table name | ||
|
|
||
| By default, tables are set using the model name in plural. If you want to change the table name from the standard, set it using the `$useTable` static property of the target Model. You should do this on the `register()` method of your `AppServiceProvider`. | ||
|
|
||
| ```php | ||
| namespace App\Providers; | ||
|
|
||
| use Illuminate\Support\ServiceProvider; | ||
| use Laragear\Package\Models\Model; | ||
|
|
||
| class AppServiceProvider extends ServiceProvider | ||
| { | ||
| public function register(): void | ||
| { | ||
| Model::$useTable = 'my_custom_table'; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Configuring the model | ||
|
|
||
| All customizable models can be configured with additional fillable, guarded, hidden, visible and appended attributes. These are _merged_ with the original configuration of the model itself, so changes are not destructive. | ||
|
|
||
| Customize the model using the available static properties: | ||
|
|
||
| - `$useCasts`: The casts attributes to merge. | ||
| - `$useFillable`: The fillable attributes to merge. | ||
| - `$useGuarded`: The guarded attributes to merge. | ||
| - `$useHidden`: The hidden attributes to merge. | ||
| - `$useVisible`: The visible attributes to merge. | ||
| - `$useAppends`: The appends attributes to merge. | ||
|
|
||
| ```php | ||
| use Illuminate\Database\Eloquent\Casts\AsEncryptedCollection; | ||
| use Vendor\Package\Models\Car; | ||
|
|
||
| class AppServiceProvider extends ServiceProvider | ||
| { | ||
| public function register(): void | ||
| { | ||
| Car::$useCasts = [ | ||
| 'is_cool' => 'boolean', | ||
| 'colors' => AsEncryptedCollection::class, | ||
| ]; | ||
|
|
||
| Car::$useHidden = ['colors']; | ||
| } | ||
| } | ||
| ``` |
Oops, something went wrong.