Options.txt

--------------------------------------
Baleen\\Migrations\\Migration\\Options
--------------------------------------

.. php:namespace: Baleen\\Migrations\\Migration

.. php:class:: Options

    .. php:method:: __construct($direction = self::DIRECTION_UP, $forced = false, $dryRun = false, $exceptionOnSkip = true, $custom = [])

        :param $direction:
        :type $forced: bool
        :param $forced:
        :type $dryRun: bool
        :param $dryRun:
        :type $exceptionOnSkip: bool
        :param $exceptionOnSkip:
        :type $custom: array
        :param $custom:

    .. php:method:: setDirection($direction)

        setDirection

        :param $direction:

    .. php:method:: getDirection()

        getDirection

        :returns: string

    .. php:method:: withDirection($direction)

        :type $direction: string
        :param $direction:
        :returns: static

    .. php:method:: isDirectionUp()

        :returns: bool

    .. php:method:: isDirectionDown()

        :returns: bool

    .. php:method:: isForced()

        :returns: bool

    .. php:method:: withForced($forced)

        withForced

        :param $forced:
        :returns: static

    .. php:method:: isDryRun()

        :returns: bool

    .. php:method:: withDryRun($dryRun)

        withDryRun

        :type $dryRun: bool
        :param $dryRun:
        :returns: static

    .. php:method:: isExceptionOnSkip()

        :returns: bool

    .. php:method:: withExceptionOnSkip($exceptionOnSkip)

        :type $exceptionOnSkip: bool
        :param $exceptionOnSkip:
        :returns: static

    .. php:method:: getCustom()

        :returns: array

    .. php:method:: withCustom($custom)

        :type $custom: array
        :param $custom:
        :returns: static

    .. php:method:: isSameValueAs(OptionsInterface $options)

        Compares the current instance with another instance of options to see if
        they contain the same values.

        :type $options: OptionsInterface
        :param $options:
        :returns: bool