Field Generation

Generate Field From Database

Phoenix provides a command to help us generate field definition code from SQL table, we can easily change our form field definition after migration.

To use this function, please prepare a migration looks like below:

use Windwalker\Core\Migration\AbstractMigration;
use Windwalker\Database\Schema\Schema;

/**
 * Migration class of ScoreInit.
 */
class ScoreInit extends AbstractMigration
{
    /**
     * Migrate Up.
     */
    public function up()
    {
        $this->createTable('scores', function(Schema $schema)
        {
            $schema->primary('id');
            $schema->integer('student_id');
            $schema->datetime('date');
            $schema->varchar('title');
            $schema->char('type')->length(5)->comment('quiz, exam');
            $schema->decimal('grade');
            $schema->text('comment');
        });
    }

    /**
     * Migrate Down.
     */
    public function down()
    {
        $this->drop('scores');
    }
}

Then run this command:

php windwalker phoenix form gen-field scores

Phoenix will generate field definitions to match data types of your table columns in terminal:

// Id
$this->text('id')
        ->label('Id')
        ->class('')
        ->labelClass('')
        ->set('readonly', true);

// Student_id
$this->text('student_id')
        ->label('Student_id')
        ->class('')
        ->labelClass('')
        ->defaultValue(null);

// Date
$this->calendar('date')
        ->label('Date')
        ->class('')
        ->labelClass('')
        ->defaultValue(null);

// Title
$this->text('title')
        ->label('Title')
        ->class('')
        ->labelClass('')
        ->defaultValue(null);

// Type
$this->list('type')
        ->label('Type')
        ->option('Quiz', 'quiz')
        ->option('Exam', 'exam')
        ->class('')
        ->labelClass('')
        ->defaultValue(1);

// Grade
$this->text('grade')
        ->label('Grade')
        ->class('')
        ->labelClass('')
        ->defaultValue(null);

// Comment
$this->textarea('comment')
        ->label('Comment')
        ->class('')
        ->labelClass('')
        ->row(7)
        ->defaultValue(null);

Now you can copy this code to your project.

Output to File

Add -o to output these code to /tmp folder.

php windwalker phoenix form gen-field scores -o

File output to: /var/www/windwalker/tmp/form/fields/scores.php.tpl

Add Options to CHAR Type

By default, char type will create a select list, we can set options in comment:

$schema->char('foo')->length(3)->comment('bar, baz');

And the field generated will be:

$this->list('foo')
    ->label('Foo')
    ->option('Bar', 'bar')
    ->option('Baz', 'Baz')
    ->class('')
    ->labelClass('')
    ->defaultValue(1);

Supported Types

All un-defined types will fallback to text field.

If you found a typo or error, please help us improve this document.