StorageInterface.txt

---------------------------------------------
Baleen\\Migrations\\Delta\\VersionRepository\\MigrationRepositoryInterface
---------------------------------------------

.. php:namespace: Baleen\\Migrations\\Storage

.. php:interface:: MigrationRepositoryInterface

    Provides a collection of Versions that have been migrated.

    .. php:method:: fetchAll()

        Reads versions from the storage file.

        :returns: Migrated

    .. php:method:: updateAll(Migrated $versions)

        Write a collection of versions to the storage file.

        :type $versions: Migrated
        :param $versions:
        :returns: bool Returns false on failure.

    .. php:method:: update(DeltaInterface $version)

        Saves or deletes a version depending on whether the version is
        respectively migrated or not.

        :type $version: DeltaInterface
        :param $version:
        :returns: bool The result of calling 'save' or 'delete' on the version.

    .. php:method:: save(DeltaInterface $version)

        Adds a version into storage

        :type $version: DeltaInterface
        :param $version:
        :returns: bool

    .. php:method:: delete(DeltaInterface $version)

        Removes a version from storage

        :type $version: DeltaInterface
        :param $version:
        :returns: bool