FixerDefinition.php 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <?php
  2. declare(strict_types=1);
  3. /*
  4. * This file is part of PHP CS Fixer.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. * Dariusz Rumiński <dariusz.ruminski@gmail.com>
  8. *
  9. * This source file is subject to the MIT license that is bundled
  10. * with this source code in the file LICENSE.
  11. */
  12. namespace PhpCsFixer\FixerDefinition;
  13. /**
  14. * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
  15. */
  16. final class FixerDefinition implements FixerDefinitionInterface
  17. {
  18. private string $summary;
  19. /**
  20. * @var list<CodeSampleInterface>
  21. */
  22. private array $codeSamples;
  23. /**
  24. * Description of Fixer and benefit of using it.
  25. */
  26. private ?string $description;
  27. /**
  28. * Description why Fixer is risky.
  29. */
  30. private ?string $riskyDescription;
  31. /**
  32. * @param list<CodeSampleInterface> $codeSamples array of samples, where single sample is [code, configuration]
  33. * @param null|string $riskyDescription null for non-risky fixer
  34. */
  35. public function __construct(
  36. string $summary,
  37. array $codeSamples,
  38. ?string $description = null,
  39. ?string $riskyDescription = null
  40. ) {
  41. $this->summary = $summary;
  42. $this->codeSamples = $codeSamples;
  43. $this->description = $description;
  44. $this->riskyDescription = $riskyDescription;
  45. }
  46. public function getSummary(): string
  47. {
  48. return $this->summary;
  49. }
  50. public function getDescription(): ?string
  51. {
  52. return $this->description;
  53. }
  54. public function getRiskyDescription(): ?string
  55. {
  56. return $this->riskyDescription;
  57. }
  58. public function getCodeSamples(): array
  59. {
  60. return $this->codeSamples;
  61. }
  62. }