0

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/db-migration -H 'Accept: application/json'

Class Description
Yiisoft\Db\Migration\Command\CommandFactory Creates commands using only named database sets, including an explicit default set.
Yiisoft\Db\Migration\Command\CreateCommand Creates a new migration.
Yiisoft\Db\Migration\Command\DatabaseCommand
Yiisoft\Db\Migration\Command\DownCommand Reverts the specified number of latest migrations.
Yiisoft\Db\Migration\Command\HistoryCommand Displays the migration history.
Yiisoft\Db\Migration\Command\MarkCommand Moves migration history to a version without executing up() or down().
Yiisoft\Db\Migration\Command\NewCommand Displays not yet applied migrations.
Yiisoft\Db\Migration\Command\RedoCommand Redoes the last few migrations.
Yiisoft\Db\Migration\Command\UpdateCommand Applies new migrations.
Yiisoft\Db\Migration\DatabaseContext Services for one execution against a named database set.
Yiisoft\Db\Migration\DatabaseSet Configuration of a named database and its migrations.
Yiisoft\Db\Migration\DatabaseSetRegistry Named database sets, in execution order. Existing command dependencies are used when no default set is configured.
Yiisoft\Db\Migration\Informer\ConsoleMigrationInformer Writes migration process informational messages into console.
Yiisoft\Db\Migration\Informer\MigrationInformerInterface Handles migration process informational messages.
Yiisoft\Db\Migration\Informer\NullMigrationInformer Ignores migration process informational messages.
Yiisoft\Db\Migration\MigrationBuilder
Yiisoft\Db\Migration\MigrationInterface The MigrationInterface defines the minimum set of methods to be implemented by a database migration.
Yiisoft\Db\Migration\Migrator
Yiisoft\Db\Migration\RevertibleMigrationInterface The RevertibleMigrationInterface defines the minimum set of methods to be implemented by a revertible database migration.
Yiisoft\Db\Migration\Runner\DownRunner
Yiisoft\Db\Migration\Runner\UpdateRunner
Yiisoft\Db\Migration\Service\Generate\Column
Yiisoft\Db\Migration\Service\Generate\CreateService
Yiisoft\Db\Migration\Service\Generate\FieldsParser
Yiisoft\Db\Migration\Service\Generate\ForeignKey
Yiisoft\Db\Migration\Service\Generate\ForeignKeyFactory
Yiisoft\Db\Migration\Service\Generate\PhpRenderer
Yiisoft\Db\Migration\Service\MigrationService
Yiisoft\Db\Migration\TransactionalMigrationInterface Allowing to use transaction in migration.