FixerDefinitionInterface.php 832 B

12345678910111213141516171819202122232425262728293031323334353637
  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. interface FixerDefinitionInterface
  17. {
  18. public function getSummary(): string;
  19. public function getDescription(): ?string;
  20. /**
  21. * @return null|string null for non-risky fixer
  22. */
  23. public function getRiskyDescription(): ?string;
  24. /**
  25. * Array of samples, where single sample is [code, configuration].
  26. *
  27. * @return list<CodeSampleInterface>
  28. */
  29. public function getCodeSamples(): array;
  30. }