FileAnalyser.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. <?php declare(strict_types=1);
  2. /*
  3. * This file is part of phpunit/php-code-coverage.
  4. *
  5. * (c) Sebastian Bergmann <sebastian@phpunit.de>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace SebastianBergmann\CodeCoverage\StaticAnalysis;
  11. /**
  12. * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
  13. *
  14. * @psalm-import-type CodeUnitFunctionType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor
  15. * @psalm-import-type CodeUnitMethodType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor
  16. * @psalm-import-type CodeUnitClassType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor
  17. * @psalm-import-type CodeUnitTraitType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor
  18. * @psalm-import-type LinesOfCodeType from \SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser
  19. * @psalm-import-type LinesType from \SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser
  20. *
  21. * @psalm-type LinesOfCodeType = array{
  22. * linesOfCode: int,
  23. * commentLinesOfCode: int,
  24. * nonCommentLinesOfCode: int
  25. * }
  26. * @psalm-type LinesType = array<int, int>
  27. */
  28. interface FileAnalyser
  29. {
  30. /**
  31. * @psalm-return array<string, CodeUnitClassType>
  32. */
  33. public function classesIn(string $filename): array;
  34. /**
  35. * @psalm-return array<string, CodeUnitTraitType>
  36. */
  37. public function traitsIn(string $filename): array;
  38. /**
  39. * @psalm-return array<string, CodeUnitFunctionType>
  40. */
  41. public function functionsIn(string $filename): array;
  42. /**
  43. * @psalm-return LinesOfCodeType
  44. */
  45. public function linesOfCodeFor(string $filename): array;
  46. /**
  47. * @psalm-return LinesType
  48. */
  49. public function executableLinesIn(string $filename): array;
  50. /**
  51. * @psalm-return LinesType
  52. */
  53. public function ignoredLinesFor(string $filename): array;
  54. }