Passed
Push — develop ( 027947...5e3b9c )
by nguereza
02:57
created

FileMaintenanceDriver::deactivate()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 3
c 1
b 0
f 0
nc 2
nop 0
dl 0
loc 5
rs 10
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant PHP
7
 * Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
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 FileMaintenanceDriver.php
34
 *
35
 *  The Maintenance driver based on file system
36
 *
37
 *  @package    Platine\Framework\Http\Maintenance\Driver
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\Framework\Http\Maintenance;
49
50
use Platine\Config\Config;
51
use Platine\Filesystem\Filesystem;
52
use Platine\Stdlib\Helper\Json;
53
/**
54
 * @class FileMaintenanceDriver
55
 * @package Platine\Framework\Http\Maintenance\Driver
56
 * @template T
57
 */
58
class FileMaintenanceDriver implements MaintenanceDriverInterface
59
{
60
    /**
61
     * The application configuration
62
     * @var Config<T>
63
     */
64
    protected Config $config;
65
66
    /**
67
     * The file system instance
68
     * @var Filesystem
69
     */
70
    protected Filesystem $filesystem;
71
72
    /**
73
     * Create new instance
74
     * @param Config<T> $config
75
     * @param Filesystem $filesystem
76
     */
77
    public function __construct(Config $config, Filesystem $filesystem)
78
    {
79
        $this->config = $config;
80
        $this->filesystem = $filesystem;
81
    }
82
83
84
    /**
85
     * {@inheritdoc}
86
     */
87
    public function active(): bool
88
    {
89
        $path = $this->getFilePath();
90
91
        return $this->filesystem->file($path)->exists();
92
    }
93
94
    /**
95
     * {@inheritdoc}
96
     */
97
    public function activate(array $data): void
98
    {
99
        $json = Json::encode($data, JSON_PRETTY_PRINT);
100
        $path = $this->getFilePath();
101
        $this->filesystem->file($path)->write($json);
102
    }
103
104
    /**
105
     * {@inheritdoc}
106
     */
107
    public function deactivate(): void
108
    {
109
        if ($this->active()) {
110
            $path = $this->getFilePath();
111
            $this->filesystem->file($path)->delete();
112
        }
113
    }
114
115
    /**
116
     * {@inheritdoc}
117
     */
118
    public function data(): array
119
    {
120
        $path = $this->getFilePath();
121
        $json = $this->filesystem->file($path)->read();
122
123
        return Json::decode($json, true);
0 ignored issues
show
Bug Best Practice introduced by
The expression return Platine\Stdlib\He...on::decode($json, true) could return the type object which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.
Loading history...
124
    }
125
126
    /**
127
     * Return the maintenance file path
128
     * @return string
129
     */
130
    protected function getFilePath(): string
131
    {
132
        return $this->config->get('maintenance.storages.file.path', '');
133
    }
134
}
135