xref: /webtrees/app/Factories/FilesystemFactory.php (revision 45ebc6c6221f90468111ed2015b8449dca331d93) 
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\Factories;
21
22use Fisharebest\Webtrees\Contracts\FilesystemFactoryInterface;
23use Fisharebest\Webtrees\Site;
24use Fisharebest\Webtrees\Tree;
25use League\Flysystem\Filesystem;
26use League\Flysystem\FilesystemOperator;
27use League\Flysystem\Local\LocalFilesystemAdapter;
28use League\Flysystem\PathPrefixing\PathPrefixedAdapter;
29
30use function realpath;
31
32/**
33 * Make a filesystem.
34 */
35class FilesystemFactory implements FilesystemFactoryInterface
36{
37    private const ROOT_DIR = __DIR__ . '/../..';
38
39    /**
40     * Create a filesystem for the user's data folder.
41     *
42     * @param string $path_prefix
43     *
44     * @return FilesystemOperator
45     */
46    public function data(string $path_prefix = ''): FilesystemOperator
47    {
48        $adapter = new LocalFilesystemAdapter(Site::getPreference('INDEX_DIRECTORY'));
49
50        if ($path_prefix !== '') {
51            $adapter = new PathPrefixedAdapter($adapter, $path_prefix);
52        }
53
54        return new Filesystem($adapter);
55    }
56
57    /**
58     * Describe a filesystem for the user's data folder.
59     *
60     * @return string
61     */
62    public function dataName(): string
63    {
64        return Site::getPreference('INDEX_DIRECTORY');
65    }
66
67    /**
68     * Create a filesystem for the application's root folder.
69     *
70     * @param string $path_prefix
71     *
72     * @return FilesystemOperator
73     */
74    public function root(string $path_prefix = ''): FilesystemOperator
75    {
76        $adapter = new LocalFilesystemAdapter(self::ROOT_DIR);
77
78        if ($path_prefix !== '') {
79            $adapter = new PathPrefixedAdapter($adapter, $path_prefix);
80        }
81
82        return new Filesystem($adapter);
83    }
84
85    /**
86     * Describe a filesystem for the application's root folder.
87     *
88     * @return string
89     */
90    public function rootName(): string
91    {
92        return realpath(self::ROOT_DIR) . '/';
93    }
94}
95