Baleen\Migrations\Delta\Repository\VersionRepositoryInterface

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
	fetchAll()	0	1	?
	fetch()	0	1	?
	updateAll()	0	1	?
	update()	0	1	?
	save()	0	1	?
	delete()	0	1	?

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <https://github.com/baleen/migrations>.
 */

namespace Baleen\Migrations\Delta\Repository;

use Baleen\Migrations\Common\Collection\CollectionInterface;
use Baleen\Migrations\Delta\DeltaId;
use Baleen\Migrations\Delta\DeltaInterface;

/**
 * Provides a collection of Versions that have been migrated.
 *
 * @author Gabriel Somoza <gabriel@strategery.io>
 */
interface VersionRepositoryInterface
{
    /**
     * Fetch versions from the storage mapper.
     *
     * @return DeltaId[]
     */
    public function fetchAll();

    /**
     * Fetch a single version from the storage mapper.
     *
     * @param string|DeltaId $id
     *
     * @return DeltaId
     */
    public function fetch($id);

    /**
     * Updates the storage by adding all versions from the collection that are migrated, and remove all versions which
     * are NOT migrated.
     *
     * @param CollectionInterface $versions
     *
     * @return bool Returns false on failure.
     */
    public function updateAll(CollectionInterface $versions);

    /**
     * Saves or deletes a version depending on whether the version is respectively migrated or not.
     *
     * @param DeltaInterface $version
     * @return bool The result of calling 'save' or 'delete' on the version.
     */
    public function update(DeltaInterface $version);

    /**
     * Adds a version into storage
     *
     * @param DeltaInterface $version
     *
     * @return bool
     */
    public function save(DeltaInterface $version);

    /**
     * Removes a version from storage
     *
     * @param DeltaInterface $version
     *
     * @return bool
     */
    public function delete(DeltaInterface $version);
}