1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* apparat-resource |
5
|
|
|
* |
6
|
|
|
* @category Apparat |
7
|
|
|
* @package Apparat\Resource |
8
|
|
|
* @subpackage Apparat\Resource |
9
|
|
|
* @author Joschi Kuphal <[email protected]> / @jkphl |
10
|
|
|
* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl |
11
|
|
|
* @license http://opensource.org/licenses/MIT The MIT License (MIT) |
12
|
|
|
*/ |
13
|
|
|
|
14
|
|
|
/*********************************************************************************** |
15
|
|
|
* The MIT License (MIT) |
16
|
|
|
* |
17
|
|
|
* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl |
18
|
|
|
* |
19
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of |
20
|
|
|
* this software and associated documentation files (the "Software"), to deal in |
21
|
|
|
* the Software without restriction, including without limitation the rights to |
22
|
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of |
23
|
|
|
* the Software, and to permit persons to whom the Software is furnished to do so, |
24
|
|
|
* subject to the following conditions: |
25
|
|
|
* |
26
|
|
|
* The above copyright notice and this permission notice shall be included in all |
27
|
|
|
* copies or substantial portions of the Software. |
28
|
|
|
* |
29
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
30
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
31
|
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR |
32
|
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
33
|
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
34
|
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
35
|
|
|
***********************************************************************************/ |
36
|
|
|
|
37
|
|
|
namespace Apparat\Resource; |
38
|
|
|
|
39
|
|
|
use Apparat\Kernel\Ports\AbstractModule; |
40
|
|
|
use Apparat\Kernel\Ports\Contract\DependencyInjectionContainerInterface; |
41
|
|
|
use Dotenv\Dotenv; |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* Resource module |
45
|
|
|
* |
46
|
|
|
* @package Apparat\Resource |
47
|
|
|
* @subpackage Apparat\Resource |
48
|
|
|
*/ |
49
|
|
|
class Module extends AbstractModule |
50
|
|
|
{ |
51
|
|
|
/** |
52
|
|
|
* Module name |
53
|
|
|
* |
54
|
|
|
* @var string |
55
|
|
|
*/ |
56
|
|
|
const NAME = 'resource'; |
57
|
|
|
|
58
|
|
|
/******************************************************************************* |
59
|
|
|
* PUBLIC METHODS |
60
|
|
|
*******************************************************************************/ |
61
|
|
|
|
62
|
|
|
/** |
63
|
|
|
* Validate the environment |
64
|
|
|
* |
65
|
|
|
* @param Dotenv $environment Environment |
66
|
|
|
*/ |
67
|
1 |
|
protected static function validateEnvironment(Dotenv $environment) |
68
|
|
|
{ |
69
|
1 |
|
parent::validateEnvironment($environment); |
70
|
1 |
|
} |
71
|
|
|
|
72
|
|
|
/******************************************************************************* |
73
|
|
|
* PRIVATE METHODS |
74
|
|
|
*******************************************************************************/ |
75
|
|
|
|
76
|
|
|
/** |
77
|
|
|
* Configure the dependency injection container |
78
|
|
|
* |
79
|
|
|
* @param DependencyInjectionContainerInterface $diContainer Dependency injection container |
80
|
|
|
* @return void |
81
|
|
|
* @see https://r.je/dice.html#example3-6 |
82
|
|
|
*/ |
83
|
1 |
|
public function configureDependencyInjection(DependencyInjectionContainerInterface $diContainer) |
84
|
|
|
{ |
85
|
1 |
|
parent::configureDependencyInjection($diContainer); |
|
|
|
|
86
|
1 |
|
} |
87
|
|
|
} |
88
|
|
|
|
PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left.
Let’s take a look at an example:
If we look at the
getEmail()
method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless:On the hand, if we look at the
setEmail()
, this method _has_ side-effects. In the following case, we could not remove the method call: