Documentation

Configuration
in package

Coveralls API configuration.

Tags
author

Kitamura Satoshi with.no.parachute@gmail.com

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

$rootDir

Absolute path to repository root directory.

protected string $rootDir

$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
$this

getCloverXmlPaths()

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
string

getEnv()

Return runtime environment name.

public getEnv() : string
Return values
string

getJsonPath()

Return absolute path to output json_file.

public getJsonPath() : string
Return values
string

getRepoToken()

Return repository token.

public getRepoToken() : null|string
Return values
null|string

getServiceName()

Return service name.

public getServiceName() : null|string
Return values
null|string

hasRepoToken()

Return whether repository token is configured.

public hasRepoToken() : bool
Return values
bool

hasServiceName()

Return whether the service name is configured.

public hasServiceName() : bool
Return values
bool

isDevEnv()

Return whether the runtime environment is dev.

public isDevEnv() : bool
Return values
bool

isDryRun()

Return whether to send json_file to jobs API.

public isDryRun() : bool
Return values
bool

isExcludeNoStatements()

Return whether to exclude source files that have no executable statements.

public isExcludeNoStatements() : bool
Return values
bool

isProdEnv()

Return whether the runtime environment is prod.

public isProdEnv() : bool
Return values
bool

isTestEnv()

Return whether the runtime environment is test.

public isTestEnv() : bool
Return values
bool

isVerbose()

Return whether to show log.

public isVerbose() : bool
Return values
bool

setCloverXmlPaths()

Set absolute paths to clover.xml.

public setCloverXmlPaths(array<string|int, string> $cloverXmlPaths) : $this
Parameters
$cloverXmlPaths : array<string|int, string>
Return values
$this

setDryRun()

Set whether to send json_file to jobs API.

public setDryRun(bool $dryRun) : $this
Parameters
$dryRun : bool
Return values
$this

setEntryPoint()

Set api entry point.

public setEntryPoint(string $entryPoint) : $this
Parameters
$entryPoint : string
Return values
$this

setEnv()

Set runtime environment name.

public setEnv(string $env) : $this
Parameters
$env : string

runtime environment name

Return values
$this

setExcludeNoStatements()

Set whether to exclude source files that have no executable statements.

public setExcludeNoStatements(bool $excludeNoStatements) : $this
Parameters
$excludeNoStatements : bool
Return values
$this

setExcludeNoStatementsUnlessFalse()

Set whether to exclude source files that have no executable statements unless false.

public setExcludeNoStatementsUnlessFalse(bool $excludeNoStatements) : $this
Parameters
$excludeNoStatements : bool
Return values
$this

setJsonPath()

Set absolute path to output json_file.

public setJsonPath(string $jsonPath) : $this
Parameters
$jsonPath : string
Return values
$this

setRepoToken()

Set repository token.

public setRepoToken(string $repoToken) : $this
Parameters
$repoToken : string
Return values
$this

setRootDir()

public setRootDir(mixed $rootDir) : mixed
Parameters
$rootDir : mixed

setServiceName()

Set service name.

public setServiceName(string $serviceName) : $this
Parameters
$serviceName : string
Return values
$this

setVerbose()

Set whether to show log.

public setVerbose(bool $verbose) : $this
Parameters
$verbose : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results