xref: /webtrees/app/Contracts/FilesystemFactoryInterface.php (revision 8d018ab2fe3b6881cab8124d97e1a69e0be79d32) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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 League\Flysystem\FilesystemOperator;
23
24/**
25 * Make a filesystem.
26 */
27interface FilesystemFactoryInterface
28{
29    /**
30     * Describe a filesystem for the user's data folder.
31     *
32     * @return string
33     */
34    public function dataName(): string;
35
36    /**
37     * Create a filesystem for the user's data folder.
38     *
39     * @param string $path_prefix
40     *
41     * @return FilesystemOperator
42     */
43    public function data(string $path_prefix = ''): FilesystemOperator;
44
45    /**
46     * Create a filesystem for the application's root folder.
47     *
48     * @param string $path_prefix
49     *
50     * @return FilesystemOperator
51     */
52    public function root(string $path_prefix = ''): FilesystemOperator;
53
54    /**
55     * Describe a filesystem for the application's root folder.
56     *
57     * @return string
58     */
59    public function rootName(): string;
60}
61