MigrationsEventArgs
extends EventArgs
in package
FinalYes
The MigrationEventsArgs class is passed to events not related to a single migration version.
Table of Contents
Properties
- $_emptyEventArgsInstance : EventArgs|null
- Single instance of EventArgs.
- $connection : Connection
- $migratorConfiguration : MigratorConfiguration
- $plan : MigrationPlanList
Methods
- __construct() : mixed
- getConnection() : Connection
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getMigratorConfiguration() : MigratorConfiguration
- getPlan() : MigrationPlanList
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs|null
$_emptyEventArgsInstance
$connection
private
Connection
$connection
$migratorConfiguration
private
MigratorConfiguration
$migratorConfiguration
$plan
private
MigrationPlanList
$plan
Methods
__construct()
public
__construct(Connection $connection, MigrationPlanList $plan, MigratorConfiguration $migratorConfiguration) : mixed
Parameters
- $connection : Connection
- $plan : MigrationPlanList
- $migratorConfiguration : MigratorConfiguration
getConnection()
public
getConnection() : Connection
Return values
ConnectiongetEmptyInstance()
Gets the single, empty and immutable EventArgs instance.
public
static getEmptyInstance() : EventArgs
This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');
The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).
Tags
Return values
EventArgsgetMigratorConfiguration()
public
getMigratorConfiguration() : MigratorConfiguration
Return values
MigratorConfigurationgetPlan()
public
getPlan() : MigrationPlanList