|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Copyright © 2017 Toan Nguyen. All rights reserved. |
|
4
|
|
|
* |
|
5
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
6
|
|
|
* file that was distributed with this source code. |
|
7
|
|
|
*/ |
|
8
|
|
|
|
|
9
|
|
|
namespace Gojira\Framework\App\Configuration; |
|
10
|
|
|
|
|
11
|
|
|
use Gojira\Framework\Data\DataObject; |
|
12
|
|
|
use Gojira\Application; |
|
13
|
|
|
|
|
14
|
|
|
/** |
|
15
|
|
|
* Base class to work with path items |
|
16
|
|
|
* |
|
17
|
|
|
* @package Gojira\Framework\App\Configuration |
|
18
|
|
|
* @author Toan Nguyen <[email protected]> |
|
19
|
|
|
*/ |
|
20
|
|
|
class Path extends DataObject implements PathInterface |
|
21
|
|
|
{ |
|
22
|
|
|
/** |
|
23
|
|
|
* Overwrite data in the object. |
|
24
|
|
|
* |
|
25
|
|
|
* The $key parameter can be string or array. |
|
26
|
|
|
* If $key is string, the attribute value will be overwritten by $value |
|
27
|
|
|
* |
|
28
|
|
|
* If $key is an array, it will overwrite all the data in the object. |
|
29
|
|
|
* |
|
30
|
|
|
* @param string|array $key |
|
31
|
|
|
* @param mixed $value |
|
32
|
|
|
* |
|
33
|
|
|
* @return $this |
|
34
|
|
|
*/ |
|
35
|
|
View Code Duplication |
public function setData($key, $value = null) |
|
|
|
|
|
|
36
|
|
|
{ |
|
37
|
|
|
if ($key === (array)$key) { |
|
38
|
|
|
$this->_data = $key; |
|
39
|
|
|
} else { |
|
40
|
|
|
$this->_data[$key] = $value; |
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
|
|
return $this; |
|
44
|
|
|
} |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* {@inheritdoc} |
|
48
|
|
|
*/ |
|
49
|
|
|
public function getPath($key = null) |
|
50
|
|
|
{ |
|
51
|
|
|
$basePath = $this->getHomePath() . self::DS . '.' . strtolower(Application::CODENAME) . self::DS; |
|
52
|
|
|
|
|
53
|
|
|
switch ($key) { |
|
54
|
|
|
case self::CONFIG_PATH: |
|
55
|
|
|
return $basePath . self::CONFIG_FILE; |
|
56
|
|
|
case self::CACHE_PATH: |
|
57
|
|
|
return $basePath . self::CACHE_FILE; |
|
58
|
|
|
case self::BASE_PATH: |
|
59
|
|
|
default: |
|
60
|
|
|
return $basePath; |
|
61
|
|
|
} |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* Returns default paths for config item |
|
66
|
|
|
* |
|
67
|
|
|
* @return array |
|
68
|
|
|
*/ |
|
69
|
|
|
public function initDefaultPaths() |
|
70
|
|
|
{ |
|
71
|
|
|
return [ |
|
72
|
|
|
self::BASE_PATH => $this->getPath(), |
|
73
|
|
|
self::CONFIG_PATH => $this->getPath(self::CONFIG_PATH), |
|
74
|
|
|
self::CACHE_PATH => $this->getPath(self::CACHE_PATH) |
|
75
|
|
|
]; |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* Returns the user's home directory |
|
80
|
|
|
* |
|
81
|
|
|
* @return null|string |
|
82
|
|
|
* @SuppressWarnings(PHPMD.Superglobals) |
|
83
|
|
|
*/ |
|
84
|
|
|
private function getHomePath() |
|
85
|
|
|
{ |
|
86
|
|
|
// Cannot use $_SERVER superglobal since that's empty during UnitUnishTestCase |
|
87
|
|
|
// getenv('HOME') isn't set on Windows and generates a Notice. |
|
88
|
|
|
$home = getenv('HOME'); |
|
89
|
|
|
if (!empty($home)) { |
|
90
|
|
|
// home should never end with a trailing slash. |
|
91
|
|
|
$home = rtrim($home, '/'); |
|
92
|
|
|
} elseif (!empty($_SERVER['HOMEDRIVE']) && !empty($_SERVER['HOMEPATH'])) { |
|
93
|
|
|
// home on windows |
|
94
|
|
|
$home = $_SERVER['HOMEDRIVE'] . $_SERVER['HOMEPATH']; |
|
95
|
|
|
// If HOMEPATH is a root directory the path can end with a slash. Make sure |
|
96
|
|
|
// that doesn't happen. |
|
97
|
|
|
$home = rtrim($home, '\\/'); |
|
98
|
|
|
} |
|
99
|
|
|
|
|
100
|
|
|
return empty($home) ? null : $home; |
|
101
|
|
|
} |
|
102
|
|
|
} |
|
103
|
|
|
|
nntoan /
Gojira
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.