LocalAdapter::file()   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 1
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 LocalAdpater.php
34
 *
35
 *  The file system local adapter class
36
 *
37
 *  @package    Platine\Filesystem\Adapter\Local
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\Adapter\Local;
49
50
use InvalidArgumentException;
51
use Platine\Filesystem\Adapter\AdapterInterface;
52
use Platine\Filesystem\DirectoryInterface;
53
use Platine\Filesystem\FileInterface;
54
use Platine\Stdlib\Helper\Path;
55
56
/**
57
 * @class LocalAdpater
58
 * @package Platine\Filesystem\Adapter\Local
59
 */
60
class LocalAdapter implements AdapterInterface
61
{
62
    /**
63
     * The root directory
64
     * @var string
65
     */
66
    protected string $root = '';
67
68
    /**
69
     * Create new instance
70
     * @param string $root
71
     */
72
    public function __construct(string $root = '')
73
    {
74
        if ($root !== '') {
75
            $root = Path::normalizePathDS($root, true);
76
77
            if (!file_exists($root) || !is_writable($root)) {
78
                throw new InvalidArgumentException(sprintf(
79
                    'Root path [%s] does not exist or is not writable',
80
                    $root
81
                ));
82
            }
83
        }
84
85
        $this->root = $root;
86
    }
87
88
89
    /**
90
    * {@inheritdoc}
91
    */
92
    public function directory(string $path = ''): DirectoryInterface
93
    {
94
        return new Directory($path, $this);
95
    }
96
97
    /**
98
    * {@inheritdoc}
99
    */
100
    public function file(string $path = ''): FileInterface
101
    {
102
        return new File($path, $this);
103
    }
104
105
    /**
106
    * {@inheritdoc}
107
    */
108
    public function get(string $path): FileInterface|DirectoryInterface|null
109
    {
110
        $absolutePath = $this->getAbsolutePath($path);
111
112
        if (is_file($absolutePath)) {
113
            return $this->file($path);
114
        }
115
116
        if (is_dir($absolutePath)) {
117
            return $this->directory($path);
118
        }
119
120
        return null;
121
    }
122
123
    /**
124
    * {@inheritdoc}
125
    */
126
    public function getAbsolutePath(string $path): string
127
    {
128
        $normalizedPath = Path::normalizePathDS($path);
129
130
        if (empty($this->root)) {
131
            return $normalizedPath;
132
        }
133
134
        if (strpos($normalizedPath, $this->root) !== 0) {
135
            $normalizedPath = $this->root . ltrim($normalizedPath, DIRECTORY_SEPARATOR);
136
        }
137
138
        return $normalizedPath;
139
    }
140
}
141