This repository has been archived by the owner on Apr 18, 2023. It is now read-only.
/
StorageInterface.php
70 lines (62 loc) · 2.21 KB
/
StorageInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?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\Storage;
use Baleen\Migrations\Version\Collection\Migrated;
use Baleen\Migrations\Version\VersionInterface;
/**
* Provides a collection of Versions that have been migrated.
*
* @author Gabriel Somoza <gabriel@strategery.io>
*/
interface StorageInterface
{
/**
* Reads versions from the storage file.
*
* @return Migrated
*/
public function fetchAll();
/**
* Write a collection of versions to the storage file.
*
* @param Migrated $versions
*
* @return bool Returns false on failure.
*/
public function saveCollection(Migrated $versions);
/**
* Saves or deletes a version depending on whether the version is respectively migrated or not.
*
* @param VersionInterface $version
* @return bool The result of calling 'save' or 'delete' on the version.
*/
public function update(VersionInterface $version);
/**
* Adds a version into storage
* @param VersionInterface $version
* @return bool
*/
public function save(VersionInterface $version);
/**
* Removes a version from storage
* @param VersionInterface $version
* @return bool
*/
public function delete(VersionInterface $version);
}