Documentation

DoctrineMigrationsConfig
in package
implements ConfigBuilderInterface

This class is automatically generated to help in creating a config.

Table of Contents

Interfaces

ConfigBuilderInterface
A ConfigBuilder provides helper methods to build a large complex array.

Properties

$_usedProperties  : mixed
$allOrNothing  : mixed
$checkDatabasePlatform  : mixed
$connection  : mixed
$customTemplate  : mixed
$em  : mixed
$enableProfiler  : mixed
$factories  : mixed
$migrations  : mixed
$migrationsPaths  : mixed
$organizeMigrations  : mixed
$services  : mixed
$storage  : mixed
$transactional  : mixed

Methods

__construct()  : mixed
allOrNothing()  : $this
Run all migrations in a transaction.
checkDatabasePlatform()  : $this
Adds an extra check in the generated migrations to allow execution only on the same platform as they were initially generated on.
connection()  : $this
Connection name to use for the migrations database.
customTemplate()  : $this
Custom template path for generated migration classes.
em()  : $this
Entity manager name to use for the migrations database (available when doctrine/orm is installed).
enableProfiler()  : $this
Whether or not to enable the profiler collector to calculate and visualize migration status. This adds some queries overhead.
factories()  : $this
getExtensionAlias()  : string
Gets the alias for the extension which config we are building.
migrations()  : $this
migrationsPath()  : $this
organizeMigrations()  : $this
Organize migrations mode. Possible values are: "BY_YEAR", "BY_YEAR_AND_MONTH", false
services()  : $this
storage()  : StorageConfig
toArray()  : array<string|int, mixed>
Gets all configuration represented as an array.
transactional()  : $this
Whether or not to wrap migrations in a single transaction.

Properties

Methods

__construct()

public __construct([array<string|int, mixed> $value = [] ]) : mixed
Parameters
$value : array<string|int, mixed> = []

checkDatabasePlatform()

Adds an extra check in the generated migrations to allow execution only on the same platform as they were initially generated on.

public checkDatabasePlatform(ParamConfigurator|mixed $value) : $this
Parameters
$value : ParamConfigurator|mixed
Tags
default

true

Return values
$this

enableProfiler()

Whether or not to enable the profiler collector to calculate and visualize migration status. This adds some queries overhead.

public enableProfiler(ParamConfigurator|bool $value) : $this
Parameters
$value : ParamConfigurator|bool
Tags
default

false

Return values
$this

factories()

public factories(string $factory, mixed $value) : $this
Parameters
$factory : string
$value : mixed
Return values
$this

getExtensionAlias()

Gets the alias for the extension which config we are building.

public getExtensionAlias() : string
Return values
string

migrationsPath()

public migrationsPath(string $namespace, mixed $value) : $this
Parameters
$namespace : string
$value : mixed
Return values
$this

services()

public services(string $service, mixed $value) : $this
Parameters
$service : string
$value : mixed
Return values
$this

toArray()

Gets all configuration represented as an array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results