MigrationManager
in package
Manages database migrations using Phinx Bridges Neuron configuration to Phinx
Table of Contents
Properties
- $_BasePath : string
- $_PhinxConfig : Config|null
- $_SettingSource : ISettingSource|null
Methods
- __construct() : mixed
- dumpSchema() : bool
- Dump database schema to YAML file
- ensureMigrationsDirectory() : bool
- Ensure migrations directory exists
- ensureSeedsDirectory() : bool
- Ensure seeds directory exists
- execute() : array<string|int, mixed>
- Execute a Phinx command
- getEnvironment() : string
- Get environment name
- getMigrationsPath() : string
- Get migrations directory path
- getMigrationTable() : string
- Get migration tracking table name
- getPhinxConfig() : Config
- Get Phinx configuration from Neuron settings
- getSchemaFilePath() : string
- Get schema file path
- getSeedsPath() : string
- Get seeds directory path
- isAutoDumpSchemaEnabled() : bool
- Check if auto-dump schema is enabled
- buildPhinxConfig() : array<string|int, mixed>
- Build Phinx configuration array from Neuron settings
- getDatabaseConfig() : array<string|int, mixed>
- Get database configuration for Phinx
- getDefaultDatabaseConfig() : array<string|int, mixed>
- Get default database configuration
- getSetting() : mixed
- Get setting value
- resolvePath() : string
- Resolve path relative to base path
Properties
$_BasePath
private
string
$_BasePath
$_PhinxConfig
private
Config|null
$_PhinxConfig
= null
$_SettingSource
private
ISettingSource|null
$_SettingSource
Methods
__construct()
public
__construct(string $BasePath[, ISettingSource|null $SettingSource = null ]) : mixed
Parameters
- $BasePath : string
-
Application base path
- $SettingSource : ISettingSource|null = null
-
Neuron settings source
dumpSchema()
Dump database schema to YAML file
public
dumpSchema([string|null $outputPath = null ]) : bool
Parameters
- $outputPath : string|null = null
-
Optional output path (uses configured path if null)
Return values
bool —Success status
ensureMigrationsDirectory()
Ensure migrations directory exists
public
ensureMigrationsDirectory() : bool
Return values
boolensureSeedsDirectory()
Ensure seeds directory exists
public
ensureSeedsDirectory() : bool
Return values
boolexecute()
Execute a Phinx command
public
execute(string $command[, array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
Parameters
- $command : string
-
Command name (migrate, rollback, status, etc.)
- $arguments : array<string|int, mixed> = []
-
Command arguments
Return values
array<string|int, mixed> —[exitCode, output]
getEnvironment()
Get environment name
public
getEnvironment() : string
Return values
stringgetMigrationsPath()
Get migrations directory path
public
getMigrationsPath() : string
Return values
stringgetMigrationTable()
Get migration tracking table name
public
getMigrationTable() : string
Return values
stringgetPhinxConfig()
Get Phinx configuration from Neuron settings
public
getPhinxConfig() : Config
Return values
ConfiggetSchemaFilePath()
Get schema file path
public
getSchemaFilePath() : string
Return values
stringgetSeedsPath()
Get seeds directory path
public
getSeedsPath() : string
Return values
stringisAutoDumpSchemaEnabled()
Check if auto-dump schema is enabled
public
isAutoDumpSchemaEnabled() : bool
Return values
boolbuildPhinxConfig()
Build Phinx configuration array from Neuron settings
private
buildPhinxConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getDatabaseConfig()
Get database configuration for Phinx
private
getDatabaseConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getDefaultDatabaseConfig()
Get default database configuration
private
getDefaultDatabaseConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getSetting()
Get setting value
private
getSetting(string $section, string $key, mixed $default) : mixed
Parameters
- $section : string
- $key : string
- $default : mixed
resolvePath()
Resolve path relative to base path
private
resolvePath(string $path) : string
Parameters
- $path : string