-
-
Notifications
You must be signed in to change notification settings - Fork 23
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
d622a58
commit 8a660f0
Showing
7 changed files
with
113 additions
and
115 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Documentation | ||
|
||
## Commands | ||
### Application | ||
- [`beyond:make:command`](commands/make-command.md) | ||
- `beyond:make:controller` | ||
- `beyond:make:policy` | ||
- `beyond:make:process` | ||
- `beyond:make:query` | ||
- `beyond:make:request` | ||
- `beyond:make:resource` | ||
- `beyond:make:rule` | ||
|
||
### Domain | ||
- [`beyond:make:action`](commands/make-action.md) | ||
- [`beyond:make:builder`](commands/make-builder.md) | ||
- [`beyond:make:collection`](commands/make-collection.md) | ||
- `beyond:make:data` | ||
- `beyond:make:enum` | ||
- `beyond:make:event` | ||
- `beyond:make:job` | ||
- `beyond:make:listener` | ||
- `beyond:make:model` | ||
- `beyond:make:observer` |
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,15 @@ | ||
# `beyond:make:action` | ||
Creates a new action. An action does run one specific task, e.g. storing or updating a model. | ||
If you need to do additional tasks like logging you should wrap those inside their own action | ||
or (maybe better) consider using a [process](make-process.md). | ||
|
||
## Signature | ||
`beyond:make:action {name} {--force}` | ||
|
||
| Parameters | Description | | ||
|------------|------------------------| | ||
| name | The name of you action | | ||
|
||
| Flags | Description | | ||
|---------|-------------------------| | ||
| --force | Overwrite existing file | |
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,31 @@ | ||
# `beyond:make:builder` | ||
Creates a new Laravel Eloquent builder for a model. | ||
|
||
> [!NOTE] | ||
> You need to add the builder to your model | ||
> ``` | ||
> public function newEloquentBuilder($q): YourBuilder | ||
> { | ||
> return new YourBuilder($q); | ||
> } | ||
> ``` | ||
> [!NOTE] | ||
> For proper IDE support add the following docblock to you model | ||
> ``` | ||
> /** | ||
> * @method static YourBuilder query() | ||
> */ | ||
> class User extends Model | ||
> ``` | ||
## Signature | ||
`beyond:make:builder {name} {--force}` | ||
|
||
| Parameters | Description | | ||
|------------|-------------------------| | ||
| name | The name of you builder | | ||
|
||
| Flags | Description | | ||
|---------|-------------------------| | ||
| --force | Overwrite existing file | |
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,22 @@ | ||
# `beyond:make:collection` | ||
Creates a new Laravel collection for a model. | ||
|
||
> [!NOTE] | ||
> You need to add the collection to your model | ||
> ``` | ||
> public function newCollection($q): YourCollection | ||
> { | ||
> return new YourCollection($q); | ||
> } | ||
> ``` | ||
## Signature | ||
`beyond:make:collection {name} {--force}` | ||
|
||
| Parameters | Description | | ||
|------------|----------------------------| | ||
| name | The name of you collection | | ||
|
||
| Flags | Description | | ||
|---------|-------------------------| | ||
| --force | Overwrite existing file | |
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,17 @@ | ||
# `beyond:make:command` | ||
Creates a new Laravel command. | ||
|
||
> [!NOTE] | ||
> You need to add the command at `App\Console\Kernel`. | ||
## Signature | ||
`beyond:make:command {name} {--command=command:name} {--force}` | ||
|
||
| Parameters | Description | | ||
|------------|-------------------------| | ||
| name | The name of you command | | ||
|
||
| Flags | Description | | ||
|-----------|-------------------------| | ||
| --command | Define the command name | | ||
| --force | Overwrite existing file | |
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 @@ | ||
# `beyond:make:process` |