PHP 클래스 Kahlan\Reporter\Coverage\Collector

파일 보기 프로젝트 열기: crysalead/kahlan 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_classes array Class dependencies.
$_collectors array Stack of active collectors.
$_coverage array The coverage data.
$_driver object The driver instance which will log the coverage data.
$_files array The files presents in Collector::_paths.
$_metrics array The metrics.
$_paths array The path(s) which contain the code source files.
$_prefix string Some prefix to remove to get the real file path.
$_processed array Temps cache of processed lines
$_tree array Cache all parsed files

공개 메소드들

메소드 설명
__construct ( array $config = [] ) The Constructor.
add ( array $coverage ) : array Adds some coverage data to the collector.
addFile ( string $file, array $coverage ) Adds some coverage data to the collector.
base ( ) : string Gets the base path used to compute relative paths.
collectable ( string $file ) : boolean Checks if a filename is collectable.
driver ( ) : object Gets the used driver.
export ( $file = null ) : array Exports coverage data.
metrics ( ) : Metrics Gets the collected metrics from coverage data.
parse ( string $file ) Retruns & cache the tree structure of a file.
realpath ( string $file ) : string Gets the real path in the original src directory.
start ( ) : boolean Starts collecting coverage data.
stop ( $mergeToParent = true ) : boolean Stops collecting coverage data.

보호된 메소드들

메소드 설명
_coverage ( string $file, array $coverage ) Helper for Collector::addFile().
_lineMetric ( string $type, integer $index, integer $value, integer $increment = 1 ) : integer Helper for Collector::metrics().
_methodMetrics ( object $node, array $metrics ) : array Helper for Collector::metrics().
_processMetrics ( string $file, object $node, array $coverage ) : array Helper for Collector::metrics().
_processNode ( string $file, object $node, array $coverage, string $path ) Helper for Collector::metrics().
_processTree ( string $file, object $nodes, array $coverage, string $path = '' ) Helper for Collector::metrics().

메소드 상세

__construct() 공개 메소드

The Constructor.
public __construct ( array $config = [] )
$config array Possible options values are: - `'driver'` _object_: the driver instance which will log the coverage data. - `'path'` _array_ : the path(s) which contain the code source files. - `'base'` _string_: the base path of the repo (default: `getcwd`). - `'prefix'` _string_: some prefix to remove to get the real file path.

_coverage() 보호된 메소드

Helper for Collector::addFile().
protected _coverage ( string $file, array $coverage )
$file string A file path.
$coverage array Some coverage related to the file path.

_lineMetric() 보호된 메소드

Helper for Collector::metrics().
protected _lineMetric ( string $type, integer $index, integer $value, integer $increment = 1 ) : integer
$type string The metric type.
$index integer The line index.
$value integer The value to update.
$increment integer The increment to perform if the line has not already been processed.
리턴 integer The metric value.

_methodMetrics() 보호된 메소드

Helper for Collector::metrics().
protected _methodMetrics ( object $node, array $metrics ) : array
$node object The node to collect metrics on.
$metrics array The metrics of the node.
리턴 array The updated metrics.

_processMetrics() 보호된 메소드

Helper for Collector::metrics().
protected _processMetrics ( string $file, object $node, array $coverage ) : array
$file string The processed file.
$node object The node to collect metrics on.
$coverage array The coverage data.
리턴 array The collected metrics.

_processNode() 보호된 메소드

Helper for Collector::metrics().
protected _processNode ( string $file, object $node, array $coverage, string $path )
$file string The processed file.
$node object The node to collect metrics on.
$coverage array The coverage data.
$path string The naming of the processed node.

_processTree() 보호된 메소드

Helper for Collector::metrics().
protected _processTree ( string $file, object $nodes, array $coverage, string $path = '' )
$file string The processed file.
$nodes object The nodes to collect metrics on.
$coverage array The coverage data.
$path string The naming of the processed node.

add() 공개 메소드

Adds some coverage data to the collector.
public add ( array $coverage ) : array
$coverage array Some coverage data.
리턴 array The current coverage data.

addFile() 공개 메소드

Adds some coverage data to the collector.
public addFile ( string $file, array $coverage )
$file string A file path.
$coverage array Some coverage related to the file path.

base() 공개 메소드

Gets the base path used to compute relative paths.
public base ( ) : string
리턴 string

collectable() 공개 메소드

Checks if a filename is collectable.
public collectable ( string $file ) : boolean
$file string A file path.
리턴 boolean

driver() 공개 메소드

Gets the used driver.
public driver ( ) : object
리턴 object

export() 공개 메소드

Exports coverage data.
public export ( $file = null ) : array
리턴 array The coverage data.

metrics() 공개 메소드

Gets the collected metrics from coverage data.
public metrics ( ) : Metrics
리턴 Metrics The collected metrics.

parse() 공개 메소드

Retruns & cache the tree structure of a file.
public parse ( string $file )
$file string the file path to use for building the tree structure.

realpath() 공개 메소드

Gets the real path in the original src directory.
public realpath ( string $file ) : string
$file string A file path or cached file path.
리턴 string The original file path.

start() 공개 메소드

Starts collecting coverage data.
public start ( ) : boolean
리턴 boolean

stop() 공개 메소드

Stops collecting coverage data.
public stop ( $mergeToParent = true ) : boolean
리턴 boolean

프로퍼티 상세

$_classes 보호되어 있는 프로퍼티

Class dependencies.
protected array $_classes
리턴 array

$_collectors 보호되어 있는 정적으로 프로퍼티

Stack of active collectors.
protected static array $_collectors
리턴 array

$_coverage 보호되어 있는 프로퍼티

The coverage data.
protected array $_coverage
리턴 array

$_driver 보호되어 있는 프로퍼티

The driver instance which will log the coverage data.
protected object $_driver
리턴 object

$_files 보호되어 있는 프로퍼티

The files presents in Collector::_paths.
protected array $_files
리턴 array

$_metrics 보호되어 있는 프로퍼티

The metrics.
protected array $_metrics
리턴 array

$_paths 보호되어 있는 프로퍼티

The path(s) which contain the code source files.
protected array $_paths
리턴 array

$_prefix 보호되어 있는 프로퍼티

Some prefix to remove to get the real file path.
protected string $_prefix
리턴 string

$_processed 보호되어 있는 프로퍼티

Temps cache of processed lines
protected array $_processed
리턴 array

$_tree 보호되어 있는 프로퍼티

Cache all parsed files
protected array $_tree
리턴 array