options() public method Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. Child classes may override this method to specify possible options. Note that the values setting via options are not available until beforeAction() is being called. public array options ( $actionID )$actionID string The action id of the current request return array The names of the options valid for the action

getMigrationHistory() protected method Returns the migration history. protected array getMigrationHistory ( $limit )$limit integer The maximum number of records in the history to be returned. null for "no limit". return array The migration history

removeMigrationHistory() protected method Removes existing migration from the history. protected void removeMigrationHistory ( $version )$version string Migration version name.

beforeAction() public method This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the $migrationPath. public boolean beforeAction ( $action )$action yii\base\Action The action to be executed. return boolean Whether the action should continue to be executed. throws yii\console\Exception if db component isn't configured

addMigrationHistory() protected method Adds new migration entry to the history. protected void addMigrationHistory ( $version )$version string Migration version name.

ensureBaseMigrationHistory() protected method Ensures migration history contains at least base migration entry. protected void ensureBaseMigrationHistory ( )

createMigration() protected method Creates a new migration instance. protected yii\mongodb\Migration createMigration ( $class )$class string The migration class name return yii\mongodb\Migration The migration instance

$db public property The DB connection object or the application component ID of the DB connection. public yii\mongodb\Connection|string $db = 'mongodb'

$migrationCollection public property The name of the collection for keeping applied migration information. public string|array $migrationCollection = 'migration'

$templateFile public property The template file for generating new migrations. This can be either a path alias (e.g. "@app/migrations/template.php") or a file path. The template file for generating new migrations. This can be either a path alias (e.g. "@app/migrations/template.php") or a file path. public string $templateFile = '@yii/mongodb/views/migration.php'