Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • Coveralls
  • JsonFile
  • Metrics
  • SourceFile
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class JsonFile

Data represents "json_file" of Coveralls API.

Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls implements Contrib\Bundle\CoverallsBundle\Entity\ArrayConvertable
Extended by Contrib\Bundle\CoverallsV1Bundle\Entity\JsonFile
Namespace: Contrib\Bundle\CoverallsV1Bundle\Entity
Author: Kitamura Satoshi <with.no.parachute@gmail.com>
Located at Contrib/Bundle/CoverallsV1Bundle/Entity/JsonFile.php
Methods summary
public array
# toArray( )

Convert to an array.

Convert to an array.

Returns

array

See

Contrib\Bundle\CoverallsBundle\Entity\ArrayConvertable::toArray()
public Contrib\Bundle\CoverallsV1Bundle\Entity\JsonFile
# fillJobs( array $env )

Fill environment variables.

Fill environment variables.

Parameters

$env
array
$env $_SERVER environment.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\JsonFile

Throws

RuntimeException
public
# excludeNoStatementsFiles( )

Exclude source files that have no executable statements.

Exclude source files that have no executable statements.

public
# sortSourceFiles( )

Sort source files by path.

Sort source files by path.

public float
# reportLineCoverage( )

Return line coverage.

Return line coverage.

Returns

float
protected mixed
# toJsonProperty( mixed $prop )

Convert to json property.

Convert to json property.

Parameters

$prop
mixed
$prop

Returns

mixed
protected array
# toJsonPropertyArray( array $propArray )

Convert to array as json property.

Convert to array as json property.

Parameters

$propArray
array
$propArray

Returns

array
protected Contrib\Bundle\CoverallsV1Bundle\Entity\JsonFile
# fillStandardizedEnvVars( array $env )

Fill standardized environment variables.

Fill standardized environment variables.

"CI_NAME", "CI_BUILD_NUMBER" must be set.

Env vars are:

  • CI_NAME
  • CI_BUILD_NUMBER
  • CI_BUILD_URL
  • CI_BRANCH
  • CI_PULL_REQUEST

These vars are supported by Codeship.

Parameters

$env
array
$env $_SERVER environment.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\JsonFile
protected Contrib\Bundle\CoverallsV1Bundle\Entity\JsonFile
# ensureJobs( )

Ensure data consistency for jobs API.

Ensure data consistency for jobs API.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\JsonFile

Throws

RuntimeException
protected boolean
# requireServiceJobId( )

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

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

Returns

boolean
protected boolean
# requireServiceNumber( )

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

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

Returns

boolean
protected boolean
# requireServiceEventType( )

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

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

Returns

boolean
protected boolean
# isUnsupportedServiceJob( )

Return whether the job is running on unsupported service.

Return whether the job is running on unsupported service.

Returns

boolean
public boolean
# hasSourceFile( string $path )

Return whether the json file has source file.

Return whether the json file has source file.

Parameters

$path
string
$path Absolute path to source file.

Returns

boolean
public Contrib\Bundle\CoverallsV1Bundle\Entity\SourceFile|null
# getSourceFile( string $path )

Return source file.

Return source file.

Parameters

$path
string
$path Absolute path to source file.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\SourceFile|null
public
# addSourceFile( Contrib\Bundle\CoverallsV1Bundle\Entity\SourceFile $sourceFile )

Add source file.

Add source file.

Parameters

$sourceFile
Contrib\Bundle\CoverallsV1Bundle\Entity\SourceFile
$sourceFile
public boolean
# hasSourceFiles( )

Return whether the json file has a source file.

Return whether the json file has a source file.

Returns

boolean
public Contrib\Bundle\CoverallsV1Bundle\Entity\SourceFile[]
# getSourceFiles( )

Return source files.

Return source files.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\SourceFile[]
public Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
# setServiceName( string $serviceName )

Set service name.

Set service name.

Parameters

$serviceName
string
$serviceName Service name.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
public string
# getServiceName( )

Return service name.

Return service name.

Returns

string
public Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
# setRepoToken( string $repoToken )

Set repository token.

Set repository token.

Parameters

$repoToken
string
$repoToken Repository token.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
public string
# getRepoToken( )

Return repository token.

Return repository token.

Returns

string
public Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
# setServiceJobId( string $serviceJobId )

Set service job id.

Set service job id.

Parameters

$serviceJobId
string
$serviceJobId Service job id.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
public string
# getServiceJobId( )

Return service job id.

Return service job id.

Returns

string
public string
# getServiceNumber( )

Return service number.

Return service number.

Returns

string
public string
# getServiceEventType( )

Return service event type.

Return service event type.

Returns

string
public string
# getServiceBuildUrl( )

Return build URL of the project.

Return build URL of the project.

Returns

string
public string
# getServiceBranch( )

Return branch name.

Return branch name.

Returns

string
public string
# getServicePullRequest( )

Return pull request info.

Return pull request info.

Returns

string
public Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
# setGit( Contrib\Bundle\CoverallsV1Bundle\Entity\Git\Git $git )

Set git data.

Set git data.

Parameters

$git
array
$git Git data.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
public array
# getGit( )

Return git data.

Return git data.

Returns

array
public Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
# setRunAt( string $runAt )

Set timestamp when the job ran.

Set timestamp when the job ran.

Parameters

$runAt
string
$runAt Timestamp.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
public string
# getRunAt( )

Return timestamp when the job ran.

Return timestamp when the job ran.

Returns

string
public Contrib\Bundle\CoverallsV1Bundle\Entity\Metrics
# getMetrics( )

Return metrics.

Return metrics.

Returns

Contrib\Bundle\CoverallsV1Bundle\Entity\Metrics
Methods inherited from Contrib\Bundle\CoverallsV1Bundle\Entity\Coveralls
__toString()
Properties summary
protected string $serviceName
#

Service name.

Service name.

protected string $serviceJobId
#

Service job id.

Service job id.

protected string $serviceNumber
#

Service number (not documented).

Service number (not documented).

protected string $serviceEventType
#

Service event type (not documented).

Service event type (not documented).

protected string $serviceBuildUrl
#

Build URL of the project (not documented).

Build URL of the project (not documented).

protected string $serviceBranch
#

Branch name (not documented).

Branch name (not documented).

protected string $servicePullRequest
#

Pull request info (not documented).

Pull request info (not documented).

protected string $repoToken
#

Repository token.

Repository token.

protected Contrib\Bundle\CoverallsV1Bundle\Entity\SourceFile[] $sourceFiles array()
#

Source files.

Source files.

protected array $git
#

Git data.

Git data.

protected string $runAt
#

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

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

"2013-02-18 00:52:48 -0800"

protected Contrib\Bundle\CoverallsV1Bundle\Entity\Metrics $metrics
#

Metrics.

Metrics.

php-coveralls API documentation generated by ApiGen 2.8.0