Generators and stubs

Generators write the files every new feature starts with: a controller, a model, a view, a migration. They follow FloCMS conventions, so the files work as soon as they're created.

A page in one command#

php flo make:route Blog

creates three files:

controllers/BlogController.php   index() action, model() accessor
models/BlogModel.php             table "blogs", all() and find()
views/blog/index.html            the view of index()

Open /blog and the page is there. php flo make:route Blog show creates a show() action and its view instead, and --admin creates an admin_ action under /admin.

Trying before writing#

Every generator takes:

• --dry-run: show which files would be created or changed, and write nothing. Add -v to see their contents.
• --force: overwrite files that already exist. Without it, generators never replace your work.

php flo make:model Category --migration --dry-run -v

What each generator writes#

The suffix is optional: make:seeder PostsSeeder and make:seeder Posts write the same file.

make:module only generates the manifest and provider. Follow modules to add services, configure bootstrap, synchronize, migrate and enable it. It does not add module-management CLI commands automatically.

Names#

Names may contain letters, digits, _ and -, and must start with a letter. Generators never write outside the project.

Generated code follows the same style everywhere: actions are lowercase with return types, models are reached through a lazy model() accessor so pages work before a database exists, and indentation is 4 spaces.

Multi-word names use hyphens in URLs and view folders: php flo make:route BlogPost creates BlogPostController, answers at /blog-post and keeps its views in views/blog-post/. This needs flocms-core 2.2.2 or newer; with 2.2.1, /blog-post answered 404.

Deleting generated code#

php flo delete:route Blog --dry-run
php flo delete:route Blog

delete:controller, delete:model, delete:view and delete:route show every file they will delete or edit, and ask first. They also remove the action or the model() accessor from the controller. --force skips the question. The remove:* names work too.

Customising the stubs#

Generators build files from templates called stubs. To change what they write, for example to add your license header or a base controller, publish the stubs and edit them:

php flo stub:publish                     # every stub
php flo stub:publish controller model    # only these

The copies go to stubs/<name>.stub in your project, and the generators use them from then on. --force replaces copies you already published.

Placeholders look like {{ class }}, {{ table }}, {{ route }}, {{ title }} and {{ permission }}. Keep the ones a stub already has; generators replace them when they write the file.