ContainerInterface
last analyzed

Size/Duplication

Total Lines 93
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 93

11 Methods

Rating   Name   Duplication   Size   Complexity  
getEnvironment() 0 1 ?
setEnvironment() 0 1 ?
unload() 0 1 ?
reload() 0 1 ?
load() 0 1 ?
save() 0 1 ?
addPath() 0 1 ?
addPaths() 0 1 ?
removePath() 0 1 ?
removePaths() 0 1 ?
delete() 0 1 ?
1
<?php
2
/**
3
 * easyProperty.com
4
 *
5
 * @link      www.easyproperty.com
6
 * @copyright Copyright (c) 2016 easyproperty.com
7
 * @license   Proprietary
8
 */
9
namespace Fuel\Config;
10
11
/**
12
 * Holds configuration data
13
 */
14
interface ContainerInterface
15
{
16
	/**
17
	 * Returns the environment
18
	 *
19
	 * @return string
20
	 */
21
	public function getEnvironment();
22
23
	/**
24
	 * Sets the environment
25
	 *
26
	 * @param string $enviroment
0 ignored issues
show
Documentation introduced by
There is no parameter named $enviroment. Did you maybe mean $environment?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

Consider the following example. The parameter $ireland is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was changed, but the annotation was not.

Loading history...
27
	 */
28
	public function setEnvironment($environment);
29
30
	/**
31
	 * Unloads a config group
32
	 *
33
	 * @param string $group
34
	 */
35
	public function unload($group);
36
37
	/**
38
	 * Reloads a group
39
	 *
40
	 * @param string         $name
41
	 * @param string|boolean $group
42
	 *
43
	 * @return array|null
44
	 */
45
	public function reload($name, $group = true);
46
47
	/**
48
	 * Loads a config file
49
	 *
50
	 * @param string              $name
51
	 * @param null|string|boolean $group
52
	 *
53
	 * @return array|null
54
	 */
55
	public function load($name, $group = null);
56
57
	/**
58
	 * Stores a config file
59
	 *
60
	 * @param string      $group
61
	 * @param string|null $destination
62
	 *
63
	 * @throws \RuntimeException
64
	 */
65
	public function save($group, $destination = null);
66
67
	/**
68
	 * Adds a path
69
	 *
70
	 * @param string $path
71
	 *
72
	 * @return $this
73
	 */
74
	public function addPath($path);
75
76
	/**
77
	 * Adds paths to look in
78
	 *
79
	 * @param array $paths
80
	 */
81
	public function addPaths(array $paths);
82
83
	/**
84
	 * Removes a path
85
	 *
86
	 * @param string $path
87
	 */
88
	public function removePath($path);
89
90
	/**
91
	 * Removes paths
92
	 *
93
	 * @param  array $paths
94
	 */
95
	public function removePaths(array $paths);
96
97
	/**
98
	 * Delete data from the container
99
	 *
100
	 * @param   string $key key to delete
101
	 *
102
	 * @return  boolean  delete success boolean
103
	 * @since   2.0.0
104
	 */
105
	public function delete($key);
106
}
107