1
|
|
|
<?php |
2
|
|
|
declare(strict_types = 1); |
3
|
|
|
/** |
4
|
|
|
* Contains interface ConfigFileInterface. |
5
|
|
|
* |
6
|
|
|
* PHP version 7.0+ |
7
|
|
|
* |
8
|
|
|
* LICENSE: |
9
|
|
|
* This file is part of Yet Another Php Eve Api Library also know as Yapeal |
10
|
|
|
* which can be used to access the Eve Online API data and place it into a |
11
|
|
|
* database. |
12
|
|
|
* Copyright (C) 2016-2017 Michael Cummings |
13
|
|
|
* |
14
|
|
|
* This program is free software: you can redistribute it and/or modify it |
15
|
|
|
* under the terms of the GNU Lesser General Public License as published by the |
16
|
|
|
* Free Software Foundation, either version 3 of the License, or (at your |
17
|
|
|
* option) any later version. |
18
|
|
|
* |
19
|
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT |
20
|
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
21
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License |
22
|
|
|
* for more details. |
23
|
|
|
* |
24
|
|
|
* You should have received a copy of the GNU Lesser General Public License |
25
|
|
|
* along with this program. If not, see |
26
|
|
|
* <http://spdx.org/licenses/LGPL-3.0.html>. |
27
|
|
|
* |
28
|
|
|
* You should be able to find a copy of this license in the COPYING-LESSER.md |
29
|
|
|
* file. A copy of the GNU GPL should also be available in the COPYING.md file. |
30
|
|
|
* |
31
|
|
|
* @author Michael Cummings <[email protected]> |
32
|
|
|
* @copyright 2016-2017 Michael Cummings |
33
|
|
|
* @license LGPL-3.0+ |
34
|
|
|
*/ |
35
|
|
|
namespace Yapeal\Configuration; |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* Class YamlConfigFile. |
39
|
|
|
*/ |
40
|
|
|
interface ConfigFileInterface |
41
|
|
|
{ |
42
|
|
|
/** |
43
|
|
|
* @param array|null $yaml The array to be flattened. If null assumes $settings. |
44
|
|
|
* |
45
|
|
|
* @return array |
46
|
|
|
*/ |
47
|
|
|
public function flattenYaml(array $yaml = null): array; |
48
|
|
|
/** |
49
|
|
|
* @return string |
50
|
|
|
* @throws \LogicException |
51
|
|
|
*/ |
52
|
|
|
public function getPathFile(): string; |
53
|
|
|
/** |
54
|
|
|
* @return array |
55
|
|
|
*/ |
56
|
|
|
public function getSettings(): array; |
57
|
|
|
/** |
58
|
|
|
* @throws \LogicException |
59
|
|
|
*/ |
60
|
|
|
public function read(); |
|
|
|
|
61
|
|
|
/** |
62
|
|
|
* @throws \LogicException |
63
|
|
|
*/ |
64
|
|
|
public function save(); |
|
|
|
|
65
|
|
|
/** |
66
|
|
|
* @param string|null $value File name with absolute path. |
67
|
|
|
*/ |
68
|
|
|
public function setPathFile(string $value = null); |
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* @param array $value |
71
|
|
|
*/ |
72
|
|
|
public function setSettings(array $value = []); |
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* @param array|null $yaml The array to be unflattened. If null assumes $settings. |
75
|
|
|
* |
76
|
|
|
* @return array |
77
|
|
|
*/ |
78
|
|
|
public function unflattenYaml(array $yaml = null): array; |
79
|
|
|
} |
80
|
|
|
|
For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a
@return
doc comment to communicate to implementors of these methods what they are expected to return.