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\Driver; |
49
|
|
|
|
50
|
|
|
use Platine\Config\Config; |
51
|
|
|
use Platine\Filesystem\Filesystem; |
52
|
|
|
use Platine\Framework\Http\Maintenance\MaintenanceDriverInterface; |
53
|
|
|
use Platine\Stdlib\Helper\Json; |
54
|
|
|
/** |
55
|
|
|
* @class FileMaintenanceDriver |
56
|
|
|
* @package Platine\Framework\Http\Maintenance\Driver |
57
|
|
|
* @template T |
58
|
|
|
*/ |
59
|
|
|
class FileMaintenanceDriver implements MaintenanceDriverInterface |
60
|
|
|
{ |
61
|
|
|
/** |
62
|
|
|
* The application configuration |
63
|
|
|
* @var Config<T> |
64
|
|
|
*/ |
65
|
|
|
protected Config $config; |
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* The file system instance |
69
|
|
|
* @var Filesystem |
70
|
|
|
*/ |
71
|
|
|
protected Filesystem $filesystem; |
72
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* Create new instance |
75
|
|
|
* @param Config<T> $config |
76
|
|
|
* @param Filesystem $filesystem |
77
|
|
|
*/ |
78
|
|
|
public function __construct(Config $config, Filesystem $filesystem) |
79
|
|
|
{ |
80
|
|
|
$this->config = $config; |
81
|
|
|
$this->filesystem = $filesystem; |
82
|
|
|
} |
83
|
|
|
|
84
|
|
|
|
85
|
|
|
/** |
86
|
|
|
* {@inheritdoc} |
87
|
|
|
*/ |
88
|
|
|
public function active(): bool |
89
|
|
|
{ |
90
|
|
|
$path = $this->getFilePath(); |
91
|
|
|
|
92
|
|
|
return $this->filesystem->file($path)->exists(); |
93
|
|
|
} |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* {@inheritdoc} |
97
|
|
|
*/ |
98
|
|
|
public function activate(array $data): void |
99
|
|
|
{ |
100
|
|
|
$json = Json::encode($data, JSON_PRETTY_PRINT); |
101
|
|
|
$path = $this->getFilePath(); |
102
|
|
|
$this->filesystem->file($path)->write($json); |
103
|
|
|
} |
104
|
|
|
|
105
|
|
|
/** |
106
|
|
|
* {@inheritdoc} |
107
|
|
|
*/ |
108
|
|
|
public function deactivate(): void |
109
|
|
|
{ |
110
|
|
|
if ($this->active()) { |
111
|
|
|
$path = $this->getFilePath(); |
112
|
|
|
$this->filesystem->file($path)->delete(); |
113
|
|
|
} |
114
|
|
|
} |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* {@inheritdoc} |
118
|
|
|
*/ |
119
|
|
|
public function data(): array |
120
|
|
|
{ |
121
|
|
|
$path = $this->getFilePath(); |
122
|
|
|
$json = $this->filesystem->file($path)->read(); |
123
|
|
|
|
124
|
|
|
return Json::decode($json, true); |
|
|
|
|
125
|
|
|
} |
126
|
|
|
|
127
|
|
|
/** |
128
|
|
|
* Return the maintenance file path |
129
|
|
|
* @return string |
130
|
|
|
*/ |
131
|
|
|
protected function getFilePath(): string |
132
|
|
|
{ |
133
|
|
|
return $this->config->get('maintenance.storages.file.path', ''); |
134
|
|
|
} |
135
|
|
|
} |
136
|
|
|
|