bluzphp / bluzman
Bluzman - Simple workflow manager for Bluz Skeleton
Installs: 1 901
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 4
Forks: 1
Open Issues: 4
Requires
- php: >=7.3
- bluzphp/framework: ~7.13
- codeception/codeception: ~4.1
- composer/composer: ~2.1
- robmorgan/phinx: ~0.12
- symfony/console: ~5.3
- symfony/event-dispatcher: ~5.3
- symfony/filesystem: ~5.3
- symfony/finder: ~5.3
- symfony/process: ~5.3
- symfony/yaml: ~5.3
Requires (Dev)
- mockery/mockery: ~1.4
- nelmio/alice: ~3.8
- php-coveralls/php-coveralls: ~2.4
- phpunit/phpunit: ~9.5
- squizlabs/php_codesniffer: ~3.6
README
Bluzman is a set of command-line tools which provides a simple workflow with an application based and maintained by Bluz framework.
Achievements
Features
- Code-generator of the application components
- Shorthand for phinx and composer tools
- Shorthand for built-in web-server
Requirements
- OS: Linux
- PHP: 7.3 (or later)
Usage
List of available commands
php ./vendor/bin/bluzman list
Code generators
All generators don't rewrite exists files, but you can run generate command with flag --force
, to rewrite all of them
Model generator
For create new model you should run the following command in the terminal:
bluzman generate:model model_name table_name
- model_name - the name of model. With this name will be created folder of model.
- table_name - the name of databases table for pattern formation properties object model.
Module generator
For create new module you should run the following command in the terminal:
bluzman generate:module module_name [controller_name]...
- module_name - the name of module. With this name will be created folder of module.
- controller_name - the name(s) of controller(s). With this name will be created controller and view. Optional.
Controller generator
For create new controller you should run the following command in the terminal:
bluzman generate:controller module_name controller_name
- module_name - the name of module. With this name will be created folder of module.
- controller_name - the name of controller. With this name will be created controller and view.
CRUD generator
For create CRUD class you should run the following command in the terminal:
bluzman generate:crud model_name
Generator will create a class in model_name/Crud.php
If you want to generate CRUD controller and view you should run the next command:
bluzman generate:crud model_name module_name
Generator will create a controller in module_name/controllers/crud.php
and a view module_name/views/crud.php
REST generator
For create REST controller you should run the following command in the terminal:
bluzman generate:rest model_name module_name
Generator will create a controller in module_name/controllers/rest.php
.
GRID generator
For create GRID class you should run the following command in the terminal:
bluzman generate:grid model_name
Generator will create a class in model_name/Grid.php
If you want to generate GRID controller and view you should run the following command in the terminal:
bluzman generate:grid model_name module_name
Generator will create a controller in module_name/controllers/grid.php
and a view module_name/views/grid.php
All-in-one generator - scaffold
Generator scaffold
will generate:
For generate all of them run the following command in the terminal:
bluzman generate:scaffold model_name table_name module_name
Migrations
All
db:command
commands is just shorthand to callphp /vendor/bin/phinx command -e default -c phinx.php
Status
bluzman db:status
Create migration
bluzman db:create UsersTable
Migrate
bluzman db:migrate
Rollback last migration
bluzman db:rollback
Create seed
bluzman db:seed:create UserSeed
Apply seed data
# all seed bluzman db:seed:run # specified seed bluzman db:seed:run UserSeed
Install and remove modules
Information about available modules will retrieve from https://github.com/bluzphp by
bluz-module
tag
Retrieve available modules:
bluzman module:list
Install module:
bluzman module:install auth
Remove module:
bluzman module:remove auth
Tests
For run all tests:
bluzman test
For run specified group:
bluzman test module-options
Server
Bluzman provides a commands list to operate with built-in PHP server.
To launch built-in PHP server you should run the following command in the terminal:
bluzman server:start --host[="..."] --port[="..."]
By default server will be available by the address 0.0.0.0:8000 and you will see all logs in the terminal.
But there is an option to run server in the background, this requires an option -b:
bluzman server:start ... -b
And if server launched in the background, it can be stopped with following command:
bluzman server:stop --host[="..."] --port[="..."]
If you want to know the status of the server you should run the command in the terminal:
bluzman server:status --host[="..."] --port[="..."]