summaryrefslogtreecommitdiff
path: root/app/Core/ObjectStorage/ObjectStorageInterface.php
blob: 92277084e8758b96b51addf8293f3d8b84dfcebb (plain)
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
<?php

namespace Kanboard\Core\ObjectStorage;

/**
 * Object Storage Interface
 *
 * @package  ObjectStorage
 * @author   Frederic Guillot
 */
interface ObjectStorageInterface
{
    /**
     * Fetch object contents
     *
     * @access public
     * @param  string  $key
     * @return string
     */
    public function get($key);

    /**
     * Save object
     *
     * @access public
     * @param  string  $key
     * @param  string  $blob
     */
    public function put($key, &$blob);

    /**
     * Output directly object content
     *
     * @access public
     * @param  string  $key
     */
    public function output($key);

    /**
     * Move local file to object storage
     *
     * @access public
     * @param  string  $filename
     * @param  string  $key
     * @return boolean
     */
    public function moveFile($filename, $key);

    /**
     * Move uploaded file to object storage
     *
     * @access public
     * @param  string  $filename
     * @param  string  $key
     * @return boolean
     */
    public function moveUploadedFile($filename, $key);

    /**
     * Remove object
     *
     * @access public
     * @param  string  $key
     * @return boolean
     */
    public function remove($key);
}