xref: /webtrees/app/Contracts/FilesystemFactoryInterface.php (revision 9458f20a3c5e8e676f65488153a8d8a76b1773fb) 
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     * @param string $path_prefix
41     *
42     * @return FilesystemOperator
43     */
44    public function data(string $path_prefix = ''): FilesystemOperator;
45
46    /**
47     * Create a filesystem for the application's root folder.
48     *
49     * @param string $path_prefix
50     *
51     * @return FilesystemOperator
52     */
53    public function root(string $path_prefix = ''): FilesystemOperator;
54
55    /**
56     * Describe a filesystem for the application's root folder.
57     *
58     * @return string
59     */
60    public function rootName(): string;
61}
62