Класс HtmlCoverageReport
Генерирует отчеты о покрытии кода в формате HTML из данных, полученных от PHPUnit
- BaseCoverageReport
-
HtmlCoverageReport
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/TestSuite/Coverage/HtmlCoverageReport.php
Краткое описание свойств
-
$_coveredprotectedСодержит общее количество покрытых строк.integer -
$_totalprotectedСодержит общее количество обработанных строк.integer
Унаследованные свойства
Краткое описание методов
- _guessSubjectName() protectedОпределяет имя класса, для которого проводился тест, на основе имени файла тестового случая.
- _paintLine() protectedОтображает HTML для одной строки в HTML-разнице.
- coverageFooter() publicГенерирует фрагмент HTML для футера отчета о покрытии
- coverageHeader() publicГенерирует фрагмент HTML для заголовка отчета о покрытии
- coverageScript() publicГенерирует JavaScript для отчета о покрытии.
- generateDiff() publicГенерирует HTML-разницу для $file на основе $coverageData.
- report() publicГенерирует HTML-отчет для отображения.
Подробное описание методов
_guessSubjectName()source protected
_guessSubjectName( ReflectionClass $testReflection )
Определяет имя класса, для которого проводился тест, на основе имени файла тестового случая.
Параметры
- ReflectionClass
$testReflection - Класс для отражения
Возвращает
stringВозможные имена тестируемого класса.
_paintLine()source protected
_paintLine( string $line , integer $linenumber , string $class , array $coveringTests )
Отображает HTML для одной строки в HTML-разнице.
Параметры
- string
$line - Содержимое строки.
- integer
$linenumber - Номер строки
- string
$class - Имя класса для использования.
- array
$coveringTests - Тесты, покрывающие строку.
Возвращает
stringcoverageFooter()source public
coverageFooter( )
Генерирует фрагмент HTML для футера отчета о покрытии
coverageHeader()source public
coverageHeader( string $filename , string $percent )
Генерирует фрагмент HTML для заголовка отчета о покрытии
Параметры
- string
$filename - Имя файла, который покрывается
- string
$percent - Процент покрытия
Возвращает
stringcoverageScript()source public
coverageScript( )
Генерирует JavaScript для отчета о покрытии.
Возвращает
stringgenerateDiff()source public
generateDiff( string $filename , array $fileLines , array $coverageData )
Генерирует HTML-разницу для $file на основе $coverageData.
Обрабатывает форматы PHPUnit 3.5 и 3.6.
3.5 использует -1 для непроверенных и -2 для мертвых. 3.6 использует массив() для непроверенных и null для мертвых.
Параметры
- string
$filename - Имя файла, для которого генерируется покрытие
- array
$fileLines - Данные файла в виде массива. См. file() для получения одного из таких массивов.
- array
$coverageData - Массив данных о покрытии для генерации HTML-разниц
Возвращает
stringHTML-разница.
report()source public
report( )
Генерирует HTML-отчет для отображения.
Возвращает
stringСкомпилированный HTML-отчет.
Унаследованные методы от BaseCoverageReport
__construct()source public
__construct( array $coverage , CakeBaseReporter $reporter )
Конструктор
Параметры
- array
$coverage - Массив данных о покрытии из PHPUnit_Test_Result
-
CakeBaseReporter$reporter - Репортер для использования в отчете о покрытии.
_calculateCoveredLines()source protected
_calculateCoveredLines( array $fileLines , array $coverageData )
Вычисляет количество покрытых строк и общее количество исполняемых строк.
Обрабатывает форматы PHPUnit 3.5 и 3.6.
3.5 использует -1 для непроверенных и -2 для мертвых. 3.6 использует массив() для непроверенных и null для мертвых.
Параметры
- array
$fileLines - Строки в файле.
- array
$coverageData - Необработанные данные о покрытии.
Возвращает
arrayМассив покрытых и общих строк.
_setParams()source protected
_setParams( CakeBaseReporter $reporter )
Извлекает параметры из репортера.
Параметры
-
CakeBaseReporter$reporter - Репортер, из которого извлекаются параметры.
filterCoverageDataByPath()source public
filterCoverageDataByPath( string $path )
Фильтрует данные о покрытии по пути. Файлы, не находящиеся в указанном пути, будут удалены.
Параметры
- string
$path - Путь для фильтрации файлов.
Возвращает
arrayМассив данных о покрытии для файлов, соответствующих заданному пути.
getPathFilter()source public
getPathFilter( )
Получает базовый путь, в котором находятся интересующие нас файлы.
Возвращает
stringПуть
setCoverage()source public
setCoverage( array $coverage )
Устанавливает массив данных о покрытии
Параметры
- array
$coverage - Данные о покрытии для использования.
Подробное описание свойств
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-HtmlCoverageReport.html