How to use phalcon-devtools to accelerate Phalcon development

Hello.
I'm Mandai, in charge of Wild on the development team.

phalcon is a very rare framework in which phalcon.so is loaded into PHP itself and the core part of the framework does not exist as a PHP file.
This format is the reason why the framework is the fastest, but as someone who is familiar with open source, I found it difficult to get used to at first because it lacks substance.

The phalcon-devtools introduced here provides commands like bake in CakePHP and oil in FuelPHP to phalcon.

Installing phalcon-devtools

Installing phalcon-devtools is very easy.
Please check the previous blog for a summary of how to install phalcon-devtools.

The version of devtools tested this time is Phalcon DevTools (3.0.4).

 

What you can do with the phalcon command

With the phalcon command, you can do various things by setting the following string as the first argument.

• info (alias of: i)
• commands (alias of: list, enumerate)
• controller (alias of: create-controller)
• module (alias of: create-module)
• model (alias of: create-model)
• all-models (alias of: create-all-models)
• project (alias of: create-project)
• scaffold (alias of: create-scaffold)
• migration (alias of: create-migration)
• webtools (alias of: create-webtools)

Let's take a look at them one by one!

 

phalcon info command

This command displays phalcon execution environment information.
When I executed it, the result was as follows.

Environment:: OS: Linux localhost.localdomain 3.10.0-514.6.1.el7.x86_64 #1 SMP Wed Jan 18 13:06:36 UTC 2017 x86_64 PHP Version: 7.0.15 PHP SAPI: cli PHP Bin: /usr/ bin/php PHP Extension Dir: /usr/lib64/php/modules PHP Bin Dir: /usr/bin Loaded PHP config: /etc/php.ini Versions:: Phalcon DevTools Version: 3.0.4 Phalcon Version: 3.0.3 AdminLTE Version: 2.3.6

 

phalcon project command

Create a new project.
When creating a new system, start with this command.

If --type=modules, it will be created with the combination front + cli module configuration by default.

If you run a command other than the phalcon project outside the phalcon project (more precisely, the path after being rewritten with --directory), the following error will occur.

Error: This command should be invoked inside a Phalcon project directory.

To be used for this determination, the project created with the "phalcon project" command contains a directory called ".phalcon".

 

phalcon module command

Unlike phalcon project, this command does not have any settings such as a base directory path, so it must be executed within the phalcon project directory.

 

phalcon controller command

Even if I run this command directly under the project directory, the error "Error: This command should be invoked inside a Phalcon project directory." occurs, so I feel like the --output option is required.

 

phalcon model command

These commands contain functions related to various models.
Before running this command, you need to complete the DB access settings in config/config.php.

If you create a table model that has a field with a hyphen in it, you can create it, but as a rule on the PHP side, an error will occur stating that you cannot use a hyphen in the name of a class property.

PHP Parse error: syntax error, unexpected '-', expecting ',' or ';' in /path/to/project/app/models/users.php on line 34

Please be careful when designing the DB.

 

phalcon all-models command

If the DB design for the application you are about to create has been completed and the tables have been built on the DB, you can quickly create models for all existing tables by running the "phalcon all-models" command without any arguments. Masu.
It is basically the same as the "phalcon model" command.

After this is completed, it may be a good idea to recreate the models that require individual settings using the "phalcon model" command with the --force option added.

 

phalcon migration command

This is a command that can perform processing related to DB migration.

Even if the number of columns decreases due to a version downgrade, etc., the columns are deleted using ALTER TABLE instead of recreating the table, so it is unlikely that the table will become empty.

If you run "phalcon migration generate" without any arguments, version control will be performed using version numbers.
If you use the --descr option with generate, it will switch to timestamp-based version control.

What's confusing is that both types of migration can be mixed.

After trying various things, it seems to be better to use version number management for normal migration, and to run migration with the --descr option when you want to create a special migration file for a specific timing. .

For example, create migration A created with version 1.0.0, and create migration B with the same content but with the --descr option.
Even if migration B is executed with migration A applied, the message "Info: Version 1.0.0 was already applied" will be displayed, indicating that migration A and migration B are internally the same. Looks like it's been confirmed.

 

phalcon scaffold command

Executing this command will create models/views/controllers in bulk.

We will also create screens with search, new creation, and update functions.
Each function itself is created with it implemented on the controller, so if you are creating a page that only performs simple CRUD, it will be much faster to implement it by modifying the one created with scaffold. .

 

phalcon webtools command

Incorporate into your project a module that makes it easy to use Phalcon commands on the browser, laid out with Twiiter Bootstrap.
You can make it unavailable later, so you can make it available during development and disable it at release.

Phalcon commands have many functions, so it's nice to be able to easily configure them using the GUI.

 

Included items

There is a directory called ide directly under the phalcon-devtools directory.
It mainly contains tools that make it easier to implement Phalcon in an IDE.

 

This is a script for creating a stub.
Rewrite the CPHALCON_DIR constant that appears at the beginning of the program to the path where Phalcon.so is installed.

// Sample define('CPHALCON_DIR' , '/usr/lib64/php/modules/');

After rewriting, when you run it, a directory named after the Phalcon version will be created and a stub for the current Phalcon environment will be generated.
However, the latest version of the stub is included, so there is no need to run it yourself.

 

Inside is a command line tool that allows you to run the phalcon command from the phpstorm console.
The contents are called phalcon.sh, which does not check the installation, but it may be useful to register it.

 

Contains stubs of functions implemented in the latest version of Phalcon.
If you want to use the latest version, it is easier to use this instead of running gen-stubs.php.

 

Modification of template

I understand that projects, models, and controllers can be automatically generated using the phalcon command, but if you create several projects, there will probably be parts that need to be modified in the same way each time.
Phalcon commands use templates when automatically generating various types, so if you rewrite the templates, you can be freed from such complicated work!
Templates are used by projects, modules, and scaffolds, and the parts enclosed in "@@" are replaced, so the base part can be modified to make it easier to use. I think it is better.

Once phalcon-devtools has been installed, you can copy a copy of the template to ~/Documents with the following command.

lang=bash cp -a $PTOOLSPATH/templates ~/Documents

 

That's it.