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
<?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\Fixer;
use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
/**
* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
* @author SpacePossum
*
* @todo Will incorporate `ConfigurationDefinitionFixerInterface` in 3.0
*/
interface ConfigurableFixerInterface extends FixerInterface
{
/**
* Set configuration.
*
* New configuration must override current one, not patch it.
* Using `null` makes fixer to use default configuration (or reset configuration from previously configured back
* to default one).
*
* Some fixers may have no configuration, then - simply pass null.
* Other ones may have configuration that will change behavior of fixer,
* eg `php_unit_strict` fixer allows to configure which methods should be fixed.
* Finally, some fixers need configuration to work, eg `header_comment`.
*
* @param null|array $configuration configuration depends on Fixer
*
* @throws InvalidFixerConfigurationException
*/
public function configure(array $configuration = null);
/*
* Defines the available configuration options of the fixer.
*
* @return FixerConfigurationResolverInterface
*
* @todo uncomment at 3.0
*/
// public function getConfigurationDefinition();
}