Scaffolding Commands

The following commands allow you to quickly scaffold additional code into your Winter project, speeding up development time.

#Create a theme

php artisan create:theme <theme code> [scaffold]

The create:theme command generates a theme folder and basic files for the theme. The first argument specifies the theme code, eg. myauthor-mytheme. The second argument ([scaffold]) is optional and allows you to choose a base theme to start from:

• tailwind: (default) Creates an empty theme using TailwindCSS and Vite
• less: Creates an empty theme using LESS and the Asset Compiler

#Create a plugin

php artisan create:plugin <plugin code>

The create:plugin command generates a plugin folder and basic files for the plugin. The first argument specifies the author and plugin name, eg. MyAuthor.MyPlugin.

#Create a component

php artisan create:component <plugin code> <component name>

The create:component command creates a new component class and the default component view. The first argument specifies the plugin code of the plugin that this component will be added into, and the second parameter specifies the component class name, eg. MyComponent.

#Create a migration

The create:migration command generates the migration file needed for a model database. The first argument specifies the plugin code of the plugin that this migration will be added into. Without any options, a bare migration file gets generated.

php artisan create:migration <plugin code>

In order to create a migration that auto-populates columns for your model, use the --create and --model options:

php artisan create:migration <plugin code> --create --model YourModel

In order to create an "update" migration, use the --update and --model options:

php artisan create:migration <plugin code> --update --model YourModel

#Create a model

php artisan create:model <plugin code> <model name>

The create:model command generates the files needed for a new model. The first argument specifies the plugin code of the plugin that this model will be added into, and the second parameter specifies the model class name, eg. MyModel.

#Create a settings model

php artisan create:settings <plugin code> [model name]

The create:settings command generates the files needed for a new Settings model. The first argument specifies the plugin code of the plugin that this model will be added into, and the second parameter is optional and specifies the Settings model class name (defaults to Settings).

#Create a backend controller

php artisan create:controller <plugin code> <controller name> [--sidebar]

The create:controller command generates a controller, configuration and view files. The first argument specifies the plugin code of the plugin that this controller will be added into, and the second parameter specifies the controller class name, eg. MyController.

The optional --sidebar flag will generate the controller with the Create, Update, & Preview views pre-configured to use the sidebar backend layout (like with the User Profile page).

#Create a form widget

php artisan create:formwidget <plugin code> <widget name>

The create:formwidget command generates a backend form widget, view and basic asset files. The first argument specifies the plugin code of the plugin that this form widget will be added into, and the second parameter specifies the form widget class name, eg. MyFormWidget.

#Create a report widget

php artisan create:reportwidget <plugin code> <widget name>

The create:reportwidget command generates a backend report widget, view and basic asset files. The first argument specifies the plugin code of the plugin that this report widget will be added into, and the second parameter specifies the report widget class name, eg. MyReportWidget.

#Create a job

The create:job command generates a job. The first argument specifies the plugin code of the plugin that this job will be added into, and the second parameter specifies the job class name, eg. MyJob.

php artisan create:job <plugin code> <job name>

By default the created job will be queueable and managed by queue worker.

The following options are supported:

#Create a console command

php artisan create:command <plugin code> <command name>

The create:command command generates a new console command. The first argument specifies the plugin code of the plugin that this console command will be added into, and the second parameter specifies the command name.

#Create a test

php artisan create:test <plugin code> <path to class to be tested or test name>

The create:test command generates a test case. The first argument specifies the plugin code of the plugin that this job will be added into, and the second specifies the relative path to the class to be tested (i.e. a test for \MyAuthor\MyPlugin\Classes\AuthManager could be generated by calling php artisan create:test myauthor.myplugin Classes\\AuthManager) or the test's name (eg. AuthManager, which would be automatically expanded to AuthManagerTest).

The following options are supported: