Cmfive

Tutorial

Let’s add a migration to our example module.
Start by navigating to the migration page in Cmfive. You can find this uder the Admin menu item. Once you are on the migrations page move to the ‘individual’ tab to view migrations sorted by module.
Scroll down the list and select our ‘Example’ module.
Click the ‘Create an example migration’ button at the top of the module list. Call it ‘InitialMigration’.

Your module folder will now contain an install folder with a migrations folder and the the newly created migration php file. This file will have a timestamp in it’s name followed by ‘-ExampleInitialMigration.php’.
Let’s use the migration to add a database table for our module by editing the up function.

public function up() {
		// UP
		$column = parent::Column();
		$column->setName('id')
				->setType('biginteger')
				->setIdentity(true);

    }

The function already contains some code. This is the definition for the id column that each table will need. Let’s now define a table for an example item that we want to store data against.

public function up() {
    // UP
    $column = parent::Column();
    $column->setName('id')
            ->setType('biginteger')
            ->setIdentity(true);
            
    if (!$this->hasTable("example_item")) { //it can be helpful to check that the table name is not used
        $this->table("example_item", [ // table names should be appended with 'ModuleName_'
            "id" => false,
            "primary_key" => "id"
        ])->addColumn($column) // add the id column
        ->addStringColumn('name')
        ->addBooleanColumn('is_checked') //boolean columns need to be appended with 'is_'
        ->addDateTimeColumn('dt_started') // Datetime columns need to be appended eith 'dt_'
        ->addIntegerColumn('my_integer')
        ->addCmfiveParameters() // this function adds some standard columns used in cmfive. dt_created, dt_modified, creator_id, modifier_id, and is_deleted.
        ->create(); 
    }
}

It is important to ensure that your migration undoes any database changes in the down function. In this case we have created a table in our up function so we will remove it in our down function.

public function down() {
    // DOWN
    $this->hasTable('example_item') ? $this->dropTable('example_item') : null;
}

Now that we have created our migration we can run it using the Cmfive UI.
In the browser, navigate to the Cmfive migrations page, view by individual modules, find the example module and click either ‘run all example migrations’ or ‘migrate to here’ on our migration.
After runnning the migration we can verify that the table was created in the database.
To roll back we can click ‘rollback to here’ next to our migration. This will run the down fuction and the table will be removed.

Make sure the migration is run and we can now look at creating our item model and our module service class. For details see here.

A framework designed for fast ERP solutions

Actions

Config

Install

Introduction

Models

Templates