Documentation

JsonFile extends Coveralls

in package

• Application

Data represents "json_file" of Coveralls API.

Tags

author

Kitamura Satoshi with.no.parachute@gmail.com

SuppressWarnings

(PHPMD.ExcessiveClassComplexity)

Table of Contents

Properties

$flagName  : string

If this is set, the job being reported will be named in the view and have it’s own independent status reported to your VCS provider.

$git  : null|Git

Git data.

$metrics  : Metrics

Metrics.

$parallel  : bool

If this is set, the build will not be considered done until a webhook has been sent to https://coveralls.io/webhook?repo_token=….

$repoToken  : null|string

Repository token.

$runAt  : null|string

A timestamp when the job ran. Must be parsable by Ruby.

$serviceBranch  : string

Branch name (not documented).

$serviceBuildUrl  : string

Build URL of the project (not documented).

$serviceEventType  : string

Service event type (not documented).

$serviceJobId  : null|string

Service job id.

$serviceName  : null|string

Service name.

$serviceNumber  : string

Service number (not documented).

$servicePullRequest  : string

Pull request info (not documented).

$sourceFiles  : array<string|int, SourceFile>

Source files.

Methods

__toString()  : string

String expression (convert to json).

addSourceFile()  : mixed

Add source file.

excludeNoStatementsFiles()  : mixed

Exclude source files that have no executable statements.

fillJobs()  : $this

Fill environment variables.

getFlagName()  : null|string

Return flag name.

getGit()  : null|Git

Return git data.

getMetrics()  : Metrics

Return metrics.

getParallel()  : null|bool

Return parallel.

getRepoToken()  : null|string

Return repository token.

getRunAt()  : null|string

Return timestamp when the job ran.

getServiceBranch()  : string

Return branch name.

getServiceBuildUrl()  : string

Return build URL of the project.

getServiceEventType()  : string

Return service event type.

getServiceJobId()  : null|string

Return service job id.

getServiceName()  : null|string

Return service name.

getServiceNumber()  : string

Return service number.

getServicePullRequest()  : string

Return pull request info.

getSourceFile()  : null|SourceFile

Return source file.

getSourceFiles()  : array<string|int, SourceFile>

Return source files.

hasSourceFile()  : bool

Return whether the json file has source file.

hasSourceFiles()  : bool

Return whether the json file has a source file.

reportLineCoverage()  : float

Return line coverage.

setFlagName()  : $this

Set flag name.

setGit()  : $this

Set git data.

setParallel()  : $this

Set parallel.

setRepoToken()  : $this

Set repository token.

setRunAt()  : $this

Set timestamp when the job ran.

setServiceJobId()  : $this

Set service job id.

setServiceName()  : $this

Set service name.

sortSourceFiles()  : mixed

Sort source files by path.

toArray()  : array<string|int, mixed>

Convert to an array.

ensureJobs()  : $this

Ensure data consistency for jobs API.

fillStandardizedEnvVars()  : $this

Fill standardized environment variables.

isUnsupportedServiceJob()  : bool

Return whether the job is running on unsupported service.

onJsonError()  : mixed

requireGithubActions()  : bool

Return whether the job requires "service_number", "service_job_id" and "repo_token" (for GithubActions).

requireRepoToken()  : bool

Return whether the job requires "repo_token" (for Travis PRO).

requireServiceEventType()  : bool

Return whether the job requires "service_event_type" (for local environment).

requireServiceJobId()  : bool

Return whether the job requires "service_job_id" (for Travis CI).

requireServiceNumber()  : bool

Return whether the job requires "service_number" (for CircleCI, Jenkins, Codeship or other CIs).

toJsonProperty()  : mixed

Convert to json property.

toJsonPropertyArray()  : array<string|int, mixed>

Convert to array as json property.

throwWhenInvalidJson()  : mixed