Configuration
in package
FinalYes
The Configuration class is responsible for defining migration configuration information.
Table of Contents
Constants
- VERSIONS_ORGANIZATION_BY_YEAR = 'year'
- VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH = 'year_and_month'
- VERSIONS_ORGANIZATION_NONE = 'none'
Properties
- $allOrNothing : bool
- $checkDbPlatform : bool
- $connectionName : string|null
- $customTemplate : string|null
- $entityManagerName : string|null
- $frozen : bool
- $isDryRun : bool
- $metadataStorageConfiguration : MetadataStorageConfiguration|null
- $migrationClasses : array<string|int, string>
- $migrationsAreOrganizedByYear : bool
- $migrationsAreOrganizedByYearAndMonth : bool
- $migrationsDirectories : array<string, string>
- $transactional : bool
Methods
- addMigrationClass() : void
- addMigrationsDirectory() : void
- areMigrationsOrganizedByYear() : bool
- areMigrationsOrganizedByYearAndMonth() : bool
- freeze() : void
- getConnectionName() : string|null
- getCustomTemplate() : string|null
- getEntityManagerName() : string|null
- getMetadataStorageConfiguration() : MetadataStorageConfiguration|null
- getMigrationClasses() : array<string|int, string>
- getMigrationDirectories() : array<string, string>
- isAllOrNothing() : bool
- isDatabasePlatformChecked() : bool
- isDryRun() : bool
- isTransactional() : bool
- setAllOrNothing() : void
- setCheckDatabasePlatform() : void
- setConnectionName() : void
- setCustomTemplate() : void
- setEntityManagerName() : void
- setIsDryRun() : void
- setMetadataStorageConfiguration() : void
- setMigrationOrganization() : void
- setMigrationsAreOrganizedByYear() : void
- setMigrationsAreOrganizedByYearAndMonth() : void
- setTransactional() : void
- assertNotFrozen() : void
Constants
VERSIONS_ORGANIZATION_BY_YEAR
public
mixed
VERSIONS_ORGANIZATION_BY_YEAR
= 'year'
VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH
public
mixed
VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH
= 'year_and_month'
VERSIONS_ORGANIZATION_NONE
public
mixed
VERSIONS_ORGANIZATION_NONE
= 'none'
Properties
$allOrNothing
private
bool
$allOrNothing
= false
$checkDbPlatform
private
bool
$checkDbPlatform
= true
$connectionName
private
string|null
$connectionName
= null
$customTemplate
private
string|null
$customTemplate
= null
$entityManagerName
private
string|null
$entityManagerName
= null
$frozen
private
bool
$frozen
= false
$isDryRun
private
bool
$isDryRun
= false
$metadataStorageConfiguration
private
MetadataStorageConfiguration|null
$metadataStorageConfiguration
= null
$migrationClasses
private
array<string|int, string>
$migrationClasses
= []
$migrationsAreOrganizedByYear
private
bool
$migrationsAreOrganizedByYear
= false
$migrationsAreOrganizedByYearAndMonth
private
bool
$migrationsAreOrganizedByYearAndMonth
= false
$migrationsDirectories
private
array<string, string>
$migrationsDirectories
= []
$transactional
private
bool
$transactional
= true
Methods
addMigrationClass()
public
addMigrationClass(string $className) : void
Parameters
- $className : string
addMigrationsDirectory()
public
addMigrationsDirectory(string $namespace, string $path) : void
Parameters
- $namespace : string
- $path : string
areMigrationsOrganizedByYear()
public
areMigrationsOrganizedByYear() : bool
Return values
boolareMigrationsOrganizedByYearAndMonth()
public
areMigrationsOrganizedByYearAndMonth() : bool
Return values
boolfreeze()
public
freeze() : void
getConnectionName()
public
getConnectionName() : string|null
Return values
string|nullgetCustomTemplate()
public
getCustomTemplate() : string|null
Return values
string|nullgetEntityManagerName()
public
getEntityManagerName() : string|null
Return values
string|nullgetMetadataStorageConfiguration()
public
getMetadataStorageConfiguration() : MetadataStorageConfiguration|null
Return values
MetadataStorageConfiguration|nullgetMigrationClasses()
public
getMigrationClasses() : array<string|int, string>
Return values
array<string|int, string>getMigrationDirectories()
public
getMigrationDirectories() : array<string, string>
Return values
array<string, string>isAllOrNothing()
public
isAllOrNothing() : bool
Return values
boolisDatabasePlatformChecked()
public
isDatabasePlatformChecked() : bool
Return values
boolisDryRun()
public
isDryRun() : bool
Return values
boolisTransactional()
public
isTransactional() : bool
Return values
boolsetAllOrNothing()
public
setAllOrNothing(bool $allOrNothing) : void
Parameters
- $allOrNothing : bool
setCheckDatabasePlatform()
public
setCheckDatabasePlatform(bool $checkDbPlatform) : void
Parameters
- $checkDbPlatform : bool
setConnectionName()
public
setConnectionName(string|null $connectionName) : void
Parameters
- $connectionName : string|null
setCustomTemplate()
public
setCustomTemplate(string|null $customTemplate) : void
Parameters
- $customTemplate : string|null
setEntityManagerName()
public
setEntityManagerName(string|null $entityManagerName) : void
Parameters
- $entityManagerName : string|null
setIsDryRun()
public
setIsDryRun(bool $isDryRun) : void
Parameters
- $isDryRun : bool
setMetadataStorageConfiguration()
public
setMetadataStorageConfiguration(MetadataStorageConfiguration $metadataStorageConfiguration) : void
Parameters
- $metadataStorageConfiguration : MetadataStorageConfiguration
setMigrationOrganization()
public
setMigrationOrganization(string $migrationOrganization) : void
Parameters
- $migrationOrganization : string
setMigrationsAreOrganizedByYear()
public
setMigrationsAreOrganizedByYear([bool $migrationsAreOrganizedByYear = true ]) : void
Parameters
- $migrationsAreOrganizedByYear : bool = true
Tags
setMigrationsAreOrganizedByYearAndMonth()
public
setMigrationsAreOrganizedByYearAndMonth([bool $migrationsAreOrganizedByYearAndMonth = true ]) : void
Parameters
- $migrationsAreOrganizedByYearAndMonth : bool = true
Tags
setTransactional()
public
setTransactional(bool $transactional) : void
Parameters
- $transactional : bool
assertNotFrozen()
private
assertNotFrozen() : void