Filesystem::getAdapter()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 1
c 1
b 0
f 0
dl 0
loc 3
rs 10
cc 1
nc 1
nop 0
1
<?php
2
3
/**
4
 * Platine Filesystem
5
 *
6
 * Platine Filesystem is file system abstraction layer extendable by adapters
7
 *
8
 * This content is released under the MIT License (MIT)
9
 *
10
 * Copyright (c) 2020 Platine Filesystem
11
 * Copyright (c) 2019 Alex Sivka
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file Filesystem.php
34
 *
35
 *  The file system main class
36
 *
37
 *  @package    Platine\Filesystem
38
 *  @author Platine Developers Team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   https://www.platine-php.com
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Filesystem;
49
50
use Platine\Filesystem\Adapter\AdapterInterface;
51
use Platine\Filesystem\Adapter\Local\LocalAdapter;
52
53
/**
54
 * @class Filesystem
55
 * @package Platine\Filesystem
56
 */
57
class Filesystem
58
{
59
    /**
60
     * The adapter instance
61
     * @var AdapterInterface
62
     */
63
    protected AdapterInterface $adapter;
64
65
    /**
66
     * Create new instance
67
     * @param AdapterInterface|null $adapter
68
     */
69
    public function __construct(?AdapterInterface $adapter = null)
70
    {
71
        $this->adapter = $adapter ?? new LocalAdapter();
72
    }
73
74
    /**
75
     * Return the adapter instance
76
     * @return AdapterInterface
77
     */
78
    public function getAdapter(): AdapterInterface
79
    {
80
        return $this->adapter;
81
    }
82
83
    /**
84
     * Return the instance of file or directory
85
     * @param string $path
86
     * @return FileInterface|DirectoryInterface|null
87
     */
88
    public function get(string $path): FileInterface|DirectoryInterface|null
89
    {
90
        return $this->adapter->get($path);
91
    }
92
93
    /**
94
     * Return the file instance
95
     * @param string $path
96
     * @return FileInterface
97
     */
98
    public function file(string $path = ''): FileInterface
99
    {
100
        return $this->adapter->file($path);
101
    }
102
103
    /**
104
     * Return the directory instance
105
     * @param string $path
106
     * @return DirectoryInterface
107
     */
108
    public function directory(string $path = ''): DirectoryInterface
109
    {
110
        return $this->adapter->directory($path);
111
    }
112
}
113