xref: /webtrees/app/Contracts/FilesystemFactoryInterface.php (revision 5bfc689774bb9a6401271c4ed15a6d50652c991b) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Contracts;
21
22use Fisharebest\Webtrees\Tree;
23use League\Flysystem\FilesystemOperator;
24
25/**
26 * Make a filesystem.
27 */
28interface FilesystemFactoryInterface
29{
30    /**
31     * Describe a filesystem for the user's data folder.
32     *
33     * @return string
34     */
35    public function dataName(): string;
36
37    /**
38     * Create a filesystem for the user's data folder.
39     *
40     * @return FilesystemOperator
41     */
42    public function data(): FilesystemOperator;
43
44    /**
45     * Create a filesystem for a tree's media folder.
46     *
47     * @param Tree $tree
48     *
49     * @return FilesystemOperator
50     */
51    public function media(Tree $tree): FilesystemOperator;
52
53    /**
54     * Create a filesystem for the application's root folder.
55     *
56     * @return FilesystemOperator
57     */
58    public function root(): FilesystemOperator;
59
60    /**
61     * Describe a filesystem for the application's root folder.
62     *
63     * @return string
64     */
65    public function rootName(): string;
66}
67