Documentation

Configurator
in package

Coveralls API configurator.

Tags
author

Kitamura Satoshi with.no.parachute@gmail.com

Table of Contents

Methods

load()  : Configuration
Load configuration.
createConfiguration()  : Configuration
Create coveralls configuration.
ensureCloverXmlPaths()  : array<string|int, string>
Ensure coverage_clover is valid.
ensureJsonPath()  : string
Ensure json_path is valid.
getGlobPaths()  : array<string|int, string>
Return absolute paths from glob path.
getGlobPathsFromArrayOption()  : array<string|int, string>
Return absolute paths from array option values.
getGlobPathsFromStringOption()  : array<string|int, string>
Return absolute paths from string option value.
parse()  : array<string|int, mixed>
Parse .coveralls.yml.
process()  : array<string|int, mixed>
Process parsed configuration according to the configuration definition.
getPotentiallyOverriddenOptionValue()  : Configuration
Get option from YAML config, potentially overridden via input params.

Methods

createConfiguration()

Create coveralls configuration.

protected createConfiguration(array<string|int, mixed> $options, string $rootDir[, InputInterface $input = null ]) : Configuration
Parameters
$options : array<string|int, mixed>

processed configuration

$rootDir : string

path to project root directory

$input : InputInterface = null
Return values
Configuration

ensureCloverXmlPaths()

Ensure coverage_clover is valid.

protected ensureCloverXmlPaths(string $option, string $rootDir, Path $file) : array<string|int, string>
Parameters
$option : string

coverage_clover option

$rootDir : string

path to project root directory

$file : Path

path object

Tags
throws
InvalidConfigurationException
Return values
array<string|int, string>

valid Absolute paths of coverage_clover

ensureJsonPath()

Ensure json_path is valid.

protected ensureJsonPath(string $option, string $rootDir, Path $file) : string
Parameters
$option : string

json_path option

$rootDir : string

path to project root directory

$file : Path

path object

Tags
throws
InvalidConfigurationException
Return values
string

valid json_path

getGlobPaths()

Return absolute paths from glob path.

protected getGlobPaths(string $path) : array<string|int, string>
Parameters
$path : string

absolute path

Tags
throws
InvalidConfigurationException
Return values
array<string|int, string>

absolute paths

getGlobPathsFromArrayOption()

Return absolute paths from array option values.

protected getGlobPathsFromArrayOption(array<string|int, mixed> $options, string $rootDir, Path $file) : array<string|int, string>
Parameters
$options : array<string|int, mixed>

coverage_clover option values

$rootDir : string

path to project root directory

$file : Path

path object

Tags
throws
InvalidConfigurationException
Return values
array<string|int, string>

absolute paths

getGlobPathsFromStringOption()

Return absolute paths from string option value.

protected getGlobPathsFromStringOption(string $option, string $rootDir, Path $file) : array<string|int, string>
Parameters
$option : string

coverage_clover option value

$rootDir : string

path to project root directory

$file : Path

path object

Tags
throws
InvalidConfigurationException
Return values
array<string|int, string>

absolute paths

parse()

Parse .coveralls.yml.

protected parse(string $coverallsYmlPath) : array<string|int, mixed>
Parameters
$coverallsYmlPath : string

Path to .coveralls.yml.

Tags
throws
ParseException

If the YAML is not valid

Return values
array<string|int, mixed>

process()

Process parsed configuration according to the configuration definition.

protected process(array<string|int, mixed> $yml) : array<string|int, mixed>
Parameters
$yml : array<string|int, mixed>

parsed configuration

Return values
array<string|int, mixed>

getPotentiallyOverriddenOptionValue()

Get option from YAML config, potentially overridden via input params.

private getPotentiallyOverriddenOptionValue(string $optionName, array<string|int, mixed> $options[, InputInterface $input = null ]) : Configuration
Parameters
$optionName : string

option name

$options : array<string|int, mixed>

processed configuration

$input : InputInterface = null
Return values
Configuration

        
On this page

Search results