* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace SebastianBergmann\CodeCoverage\StaticAnalysis; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage * * @psalm-import-type CodeUnitFunctionType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor * @psalm-import-type CodeUnitMethodType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor * @psalm-import-type CodeUnitClassType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor * @psalm-import-type CodeUnitTraitType from \SebastianBergmann\CodeCoverage\StaticAnalysis\CodeUnitFindingVisitor * @psalm-import-type LinesOfCodeType from \SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser * @psalm-import-type LinesType from \SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser * * @psalm-type LinesOfCodeType = array{ * linesOfCode: int, * commentLinesOfCode: int, * nonCommentLinesOfCode: int * } * @psalm-type LinesType = array */ interface FileAnalyser { /** * @psalm-return array */ public function classesIn(string $filename): array; /** * @psalm-return array */ public function traitsIn(string $filename): array; /** * @psalm-return array */ public function functionsIn(string $filename): array; /** * @psalm-return LinesOfCodeType */ public function linesOfCodeFor(string $filename): array; /** * @psalm-return LinesType */ public function executableLinesIn(string $filename): array; /** * @psalm-return LinesType */ public function ignoredLinesFor(string $filename): array; }