Newer
Older
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
<?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\FixerDefinition;
/**
* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
*/
final class FixerDefinition implements FixerDefinitionInterface
{
private $riskyDescription;
private $configurationDescription;
private $defaultConfiguration;
private $codeSamples;
private $summary;
private $description;
/**
* @param string $summary
* @param CodeSampleInterface[] $codeSamples array of samples, where single sample is [code, configuration]
* @param null|string $description
* @param null|string $configurationDescription null for non-configurable fixer
* @param null|array $defaultConfiguration null for non-configurable fixer
* @param null|string $riskyDescription null for non-risky fixer
*/
public function __construct(
$summary,
array $codeSamples,
$description = null,
$configurationDescription = null,
array $defaultConfiguration = null,
$riskyDescription = null
) {
if (6 === \func_num_args()) {
@trigger_error('Arguments #5 and #6 of FixerDefinition::__construct() are deprecated and will be removed in 3.0, use argument #4 instead.', E_USER_DEPRECATED);
} elseif (5 === \func_num_args()) {
@trigger_error('Argument #5 of FixerDefinition::__construct() is deprecated and will be removed in 3.0.', E_USER_DEPRECATED);
} else {
$riskyDescription = $configurationDescription;
$configurationDescription = null;
}
$this->summary = $summary;
$this->codeSamples = $codeSamples;
$this->description = $description;
$this->configurationDescription = $configurationDescription;
$this->defaultConfiguration = $defaultConfiguration;
$this->riskyDescription = $riskyDescription;
}
public function getSummary()
{
return $this->summary;
}
public function getDescription()
{
return $this->description;
}
public function getConfigurationDescription()
{
@trigger_error(sprintf('%s is deprecated and will be removed in 3.0.', __METHOD__), E_USER_DEPRECATED);
return $this->configurationDescription;
}
public function getDefaultConfiguration()
{
@trigger_error(sprintf('%s is deprecated and will be removed in 3.0.', __METHOD__), E_USER_DEPRECATED);
return $this->defaultConfiguration;
}
public function getRiskyDescription()
{
return $this->riskyDescription;
}
public function getCodeSamples()
{
return $this->codeSamples;
}
}