• Home
• Doctrine
• DBAL
• Migrations
• Configuration
• Configuration

PHP Class Doctrine\DBAL\Migrations\Configuration\Configuration

Show file Open project: doctrine/migrations Class Usage Examples

Public Methods

Method	Description
__construct ( Doctrine\DBAL\Connection $connection, Doctrine\DBAL\Migrations\OutputWriter $outputWriter = null, Doctrine\DBAL\Migrations\Finder\MigrationFinderInterface $finder = null )	Construct a migration configuration object.
areMigrationsOrganizedByYear ( ) : boolean
areMigrationsOrganizedByYearAndMonth ( ) : boolean
createMigrationTable ( ) : boolean	Create the migration table to track migrations with.
formatVersion ( string $version ) : string	Returns a timestamp version as a formatted date
generateVersionNumber ( DateTimeInterface $now = null ) : string	Generate a new migration version. A version is (usually) a datetime string.
getAvailableVersions ( ) : array	Returns an array of available migration version numbers.
getConnection ( ) : Doctrine\DBAL\Connection	Returns the Connection instance
getCurrentVersion ( ) : string	Returns the current migrated version from the versions table.
getDateTime ( $version ) : string	Returns the datetime of a migration
getLatestVersion ( ) : string	Returns the latest available migration version.
getMigratedVersions ( ) : Version[]	Returns all migrated versions from the versions table, in an array.
getMigrations ( ) : Version[]	Get the array of registered migration versions.
getMigrationsColumnName ( ) : string	Returns the migration column name
getMigrationsDirectory ( ) : string	Returns the new migrations directory where new migration classes are generated
getMigrationsNamespace ( ) : string	Returns the migrations namespace
getMigrationsTableName ( ) : string	Returns the migration table name
getMigrationsToExecute ( string $direction, string $to ) : Version[]	Returns the array of migrations to executed based on the given direction and target version number.
getName ( ) : string	Returns the name of this set of migrations
getNextVersion ( ) : string | null	Returns the version following the current version.
getNumberOfAvailableMigrations ( ) : integer	Returns the total number of available migration versions
getNumberOfExecutedMigrations ( ) : integer	Returns the total number of executed migration versions
getOutputWriter ( ) : Doctrine\DBAL\Migrations\OutputWriter	Returns the OutputWriter instance
getPrevVersion ( ) : string | null	Returns the version prior to the current version.
getRelativeVersion ( $version, $delta ) : string | null	Returns the version with the specified offset to the specified version.
getVersion ( string $version ) : Version	Returns the Version instance for a given version in the format YYYYMMDDHHMMSS.
hasVersion ( string $version ) : boolean	Check if a version exists.
hasVersionMigrated ( Version $version ) : boolean	Check if a version has been migrated or not yet
registerMigration ( string $version, string $class ) : Version	Register a single migration version to be executed by a AbstractMigration class.
registerMigrations ( array $migrations ) : Version[]	Register an array of migrations. Each key of the array is the version and the value is the migration class name.
registerMigrationsFromDirectory ( string $path ) : Version[]	Register migrations from a given directory. Recursively finds all files with the pattern VersionYYYYMMDDHHMMSS.php as the filename and registers them as migrations.
resolveVersionAlias ( $alias ) : string | null	Returns the version number from an alias.
setMigrationsAreOrganizedByYear ( boolean $migrationsAreOrganizedByYear = true )
setMigrationsAreOrganizedByYearAndMonth ( boolean $migrationsAreOrganizedByYearAndMonth = true )
setMigrationsColumnName ( string $columnName )	Set the migration column name
setMigrationsDirectory ( string $migrationsDirectory )	Set the new migrations directory where new migration classes are generated
setMigrationsFinder ( Doctrine\DBAL\Migrations\Finder\MigrationFinderInterface $finder )	Set the implementation of the migration finder.
setMigrationsNamespace ( string $migrationsNamespace )	Set the migrations namespace
setMigrationsTableName ( string $tableName )	Set the migration table name
setName ( string $name )	Set the name of this set of migrations
setOutputWriter ( Doctrine\DBAL\Migrations\OutputWriter $outputWriter )	Sets the output writer.
validate ( )	Validation that this instance has all the required properties configured

Protected Methods

Method	Description
connect ( ) : boolean	Explicitely opens the database connection. This is done to play nice with DBAL's MasterSlaveConnection. Which, in some cases, connects to a follower when fetching the executed migrations. If a follower is lagging significantly behind that means the migrations system may see unexecuted migrations that were actually executed earlier.
findMigrations ( string $path ) : array	Find all the migrations in a given directory.

Private Methods

Method	Description
ensureMigrationClassExists ( string $class )
ensureOrganizeMigrationsIsCompatibleWithFinder ( )
shouldExecuteMigration ( string $direction, Version $version, string $to, array $migrated ) : boolean	Check if we should execute a migration for a given direction and target migration version.

Method Details