From 3b397e5b840d738c756919f378dbe41da35f872d Mon Sep 17 00:00:00 2001 From: Luke Towers Date: Wed, 6 Oct 2021 00:04:26 -0600 Subject: [PATCH] Document new scaffolding commands Refs wintercms/storm#37 & https://github.com/wintercms/winter/discussions/201 --- console-scaffolding.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/console-scaffolding.md b/console-scaffolding.md index 3b529f1f..9fd716af 100644 --- a/console-scaffolding.md +++ b/console-scaffolding.md @@ -1,9 +1,11 @@ # Scaffolding commands - [Scaffolding commands](#scaffolding-commands) + - [Create a theme](#scaffold-create-theme) - [Create a plugin](#scaffold-create-plugin) - [Create a component](#scaffold-create-component) - [Create a model](#scaffold-create-model) + - [Create a settings model](#scaffold-create-settings-model) - [Create a back-end controller](#scaffold-create-controller) - [Create a form widget](#scaffold-create-formwidget) - [Create a report widget](#scaffold-create-reportwidget) @@ -14,50 +16,64 @@ Use the scaffolding commands to speed up the development process. + +### Create a Theme + +The `create:theme` command generates a theme folder and basic files for the theme. The parameter specifies the theme code. + + php artisan create:theme myauthor-mytheme + -### Create a plugin +### Create a Plugin The `create:plugin` command generates a plugin folder and basic files for the plugin. The parameter specifies the author and plugin name. php artisan create:plugin Acme.Blog -### Create a component +### Create a Component The `create:component` command creates a new component class and the default component view. The first parameter specifies the author and plugin name. The second parameter specifies the component class name. php artisan create:component Acme.Blog Post -### Create a model +### Create a Model The `create:model` command generates the files needed for a new model. The first parameter specifies the author and plugin name. The second parameter specifies the model class name. php artisan create:model Acme.Blog Post + + +### Create a Settings Model + +The `create:settings` command generates the files needed for a new [Settings model](../plugin/settings#database-settings). The first parameter specifies the author and plugin name. The second parameter is optional and specifies the Settings model class name (defaults to `Settings`). + + php artisan create:settings Acme.Blog CustomSettings -### Create a back-end controller +### Create a back-end Controller The `create:controller` command generates a controller, configuration and view files. The first parameter specifies the author and plugin name. The second parameter specifies the controller class name. php artisan create:controller Acme.Blog Posts -### Create a form widget +### Create a FormWidget The `create:formwidget` command generates a back-end form widget, view and basic asset files. The first parameter specifies the author and plugin name. The second parameter specifies the form widget class name. php artisan create:formwidget Acme.Blog CategorySelector -### Create a report widget +### Create a ReportWidget The `create:reportwidget` command generates a back-end report widget, view and basic asset files. The first parameter specifies the author and plugin name. The second parameter specifies the report widget class name. php artisan create:reportwidget Acme.Blog TopPosts -### Create a console command +### Create a console Command The `create:command` command generates a [new console command](../console/development). The first parameter specifies the author and plugin name. The second parameter specifies the command name.