5.1.3.7. Baleen\Migrations\Migration\OptionsInterface

interface OptionsInterface

Options value object. Used to configure the migration jobs and provide information about them to the migration.

getDirection()

The direction that we’re migrating

Returns:string
withDirection($direction)

MUST return a new OptionsInterface instance with the same property values as the current one except for the new direction.

Parameters:
  • $direction (string) –
Returns:

static

isDirectionUp()
Returns:bool
isDirectionDown()
Returns:bool
isForced()
Returns:bool
withForced($forced)

MUST return a new OptionsInterface instance with the same property values as the current one except for the new value for the “forced” property.

Parameters:
  • $forced
Returns:

static

isDryRun()
Returns:bool
withDryRun($dryRun)

MUST return a new OptionsInterface instance with the same property values as the current one except for the new value for the “dryRun” property.

Parameters:
  • $dryRun (bool) –
Returns:

static

isExceptionOnSkip()
Returns:bool
withExceptionOnSkip($exceptionOnSkip)

MUST return a new OptionsInterface instance with the same property values as the current one except for the new value for the “exceptionOnSkip” property.

Parameters:
  • $exceptionOnSkip (bool) –
Returns:

static

getCustom()
Returns:array
withCustom($custom)

MUST return a new OptionsInterface instance with the same property values as the current one except for the new value for the “custom” array.

Parameters:
  • $custom (array) –
Returns:

static

isSameValueAs(OptionsInterface $options)

Returns true if the current object is the same as the parameter.

Parameters:
Returns:

boolean