1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?php
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer;
use PhpCsFixer\Fixer\FixerInterface;
/**
* @author Fabien Potencier <fabien@symfony.com>
* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
*/
interface ConfigInterface
{
/**
* Returns the path to the cache file.
*
* @return null|string Returns null if not using cache
*/
public function getCacheFile();
/**
* Returns the custom fixers to use.
*
* @return FixerInterface[]
*/
public function getCustomFixers();
/**
* Returns files to scan.
*
* @return iterable|\Traversable
*/
public function getFinder();
/**
* @return string
*/
public function getFormat();
/**
* Returns true if progress should be hidden.
*
* @return bool
*/
public function getHideProgress();
/**
* @return string
*/
public function getIndent();
/**
* @return string
*/
public function getLineEnding();
/**
* Returns the name of the configuration.
*
* The name must be all lowercase and without any spaces.
*
* @return string The name of the configuration
*/
public function getName();
/**
* Get configured PHP executable, if any.
*
* @return null|string
*/
public function getPhpExecutable();
/**
* Check if it is allowed to run risky fixers.
*
* @return bool
*/
public function getRiskyAllowed();
/**
* Get rules.
*
* Keys of array are names of fixers/sets, values are true/false.
*
* @return array
*/
public function getRules();
/**
* Returns true if caching should be enabled.
*
* @return bool
*/
public function getUsingCache();
/**
* Adds a suite of custom fixers.
*
* Name of custom fixer should follow `VendorName/rule_name` convention.
*
* @param FixerInterface[]|iterable|\Traversable $fixers
*/
public function registerCustomFixers($fixers);
/**
* Sets the path to the cache file.
*
* @param string $cacheFile
*
* @return self
*/
public function setCacheFile($cacheFile);
/**
* @param iterable|string[]|\Traversable $finder
*
* @return self
*/
public function setFinder($finder);
/**
* @param string $format
*
* @return self
*/
public function setFormat($format);
/**
* @param bool $hideProgress
*
* @return self
*/
public function setHideProgress($hideProgress);
/**
* @param string $indent
*
* @return self
*/
public function setIndent($indent);
/**
* @param string $lineEnding
*
* @return self
*/
public function setLineEnding($lineEnding);
/**
* Set PHP executable.
*
* @param null|string $phpExecutable
*
* @return self
*/
public function setPhpExecutable($phpExecutable);
/**
* Set if it is allowed to run risky fixers.
*
* @param bool $isRiskyAllowed
*
* @return self
*/
public function setRiskyAllowed($isRiskyAllowed);
/**
* Set rules.
*
* Keys of array are names of fixers or sets.
* Value for set must be bool (turn it on or off).
* Value for fixer may be bool (turn it on or off) or array of configuration
* (turn it on and contains configuration for FixerInterface::configure method).
*
* @param array $rules
*
* @return self
*/
public function setRules(array $rules);
/**
* @param bool $usingCache
*
* @return self
*/
public function setUsingCache($usingCache);
}