Configuration
in package
Coveralls API configuration.
Tags
Table of Contents
Properties
- $cloverXmlPaths : array<string|int, mixed>
- Absolute paths to clover.xml.
- $dryRun : bool
- Whether to send json_file to jobs API.
- $entryPoint : string
- Entry point which is used for api calls.
- $env : string
- Runtime environment name.
- $excludeNoStatements : bool
- Whether to exclude source files that have no executable statements.
- $jsonPath : string
- Absolute path to output json_file.
- $repoToken : string
- repo_token.
- $rootDir : string
- Absolute path to repository root directory.
- $serviceName : string
- service_name.
- $verbose : bool
- Whether to show log.
Methods
- addCloverXmlPath() : $this
- Add absolute path to clover.xml.
- getCloverXmlPaths() : array<string|int, string>
- Return absolute path to clover.xml.
- getEntryPoint() : string
- Return api entry point.
- getEnv() : string
- Return runtime environment name.
- getJsonPath() : string
- Return absolute path to output json_file.
- getRepoToken() : null|string
- Return repository token.
- getRootDir() : mixed
- getServiceName() : null|string
- Return service name.
- hasRepoToken() : bool
- Return whether repository token is configured.
- hasServiceName() : bool
- Return whether the service name is configured.
- isDevEnv() : bool
- Return whether the runtime environment is dev.
- isDryRun() : bool
- Return whether to send json_file to jobs API.
- isExcludeNoStatements() : bool
- Return whether to exclude source files that have no executable statements.
- isProdEnv() : bool
- Return whether the runtime environment is prod.
- isTestEnv() : bool
- Return whether the runtime environment is test.
- isVerbose() : bool
- Return whether to show log.
- setCloverXmlPaths() : $this
- Set absolute paths to clover.xml.
- setDryRun() : $this
- Set whether to send json_file to jobs API.
- setEntryPoint() : $this
- Set api entry point.
- setEnv() : $this
- Set runtime environment name.
- setExcludeNoStatements() : $this
- Set whether to exclude source files that have no executable statements.
- setExcludeNoStatementsUnlessFalse() : $this
- Set whether to exclude source files that have no executable statements unless false.
- setJsonPath() : $this
- Set absolute path to output json_file.
- setRepoToken() : $this
- Set repository token.
- setRootDir() : mixed
- setServiceName() : $this
- Set service name.
- setVerbose() : $this
- Set whether to show log.
Properties
$cloverXmlPaths
Absolute paths to clover.xml.
protected
array<string|int, mixed>
$cloverXmlPaths
= []
$dryRun
Whether to send json_file to jobs API.
protected
bool
$dryRun
= true
$entryPoint
Entry point which is used for api calls.
protected
string
$entryPoint
$env
Runtime environment name.
protected
string
$env
= 'prod'
$excludeNoStatements
Whether to exclude source files that have no executable statements.
protected
bool
$excludeNoStatements
= false
$jsonPath
Absolute path to output json_file.
protected
string
$jsonPath
$repoToken
repo_token.
protected
string
$repoToken
$rootDir
Absolute path to repository root directory.
protected
string
$rootDir
$serviceName
service_name.
protected
string
$serviceName
$verbose
Whether to show log.
protected
bool
$verbose
= false
Methods
addCloverXmlPath()
Add absolute path to clover.xml.
public
addCloverXmlPath(string $cloverXmlPath) : $this
Parameters
- $cloverXmlPath : string
Return values
$thisgetCloverXmlPaths()
Return absolute path to clover.xml.
public
getCloverXmlPaths() : array<string|int, string>
Return values
array<string|int, string>getEntryPoint()
Return api entry point.
public
getEntryPoint() : string
Return values
stringgetEnv()
Return runtime environment name.
public
getEnv() : string
Return values
stringgetJsonPath()
Return absolute path to output json_file.
public
getJsonPath() : string
Return values
stringgetRepoToken()
Return repository token.
public
getRepoToken() : null|string
Return values
null|stringgetRootDir()
public
getRootDir() : mixed
getServiceName()
Return service name.
public
getServiceName() : null|string
Return values
null|stringhasRepoToken()
Return whether repository token is configured.
public
hasRepoToken() : bool
Return values
boolhasServiceName()
Return whether the service name is configured.
public
hasServiceName() : bool
Return values
boolisDevEnv()
Return whether the runtime environment is dev.
public
isDevEnv() : bool
Return values
boolisDryRun()
Return whether to send json_file to jobs API.
public
isDryRun() : bool
Return values
boolisExcludeNoStatements()
Return whether to exclude source files that have no executable statements.
public
isExcludeNoStatements() : bool
Return values
boolisProdEnv()
Return whether the runtime environment is prod.
public
isProdEnv() : bool
Return values
boolisTestEnv()
Return whether the runtime environment is test.
public
isTestEnv() : bool
Return values
boolisVerbose()
Return whether to show log.
public
isVerbose() : bool
Return values
boolsetCloverXmlPaths()
Set absolute paths to clover.xml.
public
setCloverXmlPaths(array<string|int, string> $cloverXmlPaths) : $this
Parameters
- $cloverXmlPaths : array<string|int, string>
Return values
$thissetDryRun()
Set whether to send json_file to jobs API.
public
setDryRun(bool $dryRun) : $this
Parameters
- $dryRun : bool
Return values
$thissetEntryPoint()
Set api entry point.
public
setEntryPoint(string $entryPoint) : $this
Parameters
- $entryPoint : string
Return values
$thissetEnv()
Set runtime environment name.
public
setEnv(string $env) : $this
Parameters
- $env : string
-
runtime environment name
Return values
$thissetExcludeNoStatements()
Set whether to exclude source files that have no executable statements.
public
setExcludeNoStatements(bool $excludeNoStatements) : $this
Parameters
- $excludeNoStatements : bool
Return values
$thissetExcludeNoStatementsUnlessFalse()
Set whether to exclude source files that have no executable statements unless false.
public
setExcludeNoStatementsUnlessFalse(bool $excludeNoStatements) : $this
Parameters
- $excludeNoStatements : bool
Return values
$thissetJsonPath()
Set absolute path to output json_file.
public
setJsonPath(string $jsonPath) : $this
Parameters
- $jsonPath : string
Return values
$thissetRepoToken()
Set repository token.
public
setRepoToken(string $repoToken) : $this
Parameters
- $repoToken : string
Return values
$thissetRootDir()
public
setRootDir(mixed $rootDir) : mixed
Parameters
- $rootDir : mixed
setServiceName()
Set service name.
public
setServiceName(string $serviceName) : $this
Parameters
- $serviceName : string
Return values
$thissetVerbose()
Set whether to show log.
public
setVerbose(bool $verbose) : $this
Parameters
- $verbose : bool