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

  • Configuration
  • Configurator
  • CoverallsConfiguration
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class Configuration

Coveralls API configuration.

Namespace: Contrib\Bundle\CoverallsV1Bundle\Config
Author: Kitamura Satoshi <with.no.parachute@gmail.com>
Located at Contrib/Bundle/CoverallsV1Bundle/Config/Configuration.php
Methods summary
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setRepoToken( string $repoToken )

Set repository token.

Set repository token.

Parameters

$repoToken
string
$repoToken

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public boolean
# hasRepoToken( )

Return whether repository token is configured.

Return whether repository token is configured.

Returns

boolean
public string|null
# getRepoToken( )

Return repository token.

Return repository token.

Returns

string|null
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setServiceName( string $serviceName )

Set service name.

Set service name.

Parameters

$serviceName
string
$serviceName

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public boolean
# hasServiceName( )

Return whether the service name is configured.

Return whether the service name is configured.

Returns

boolean
public string|null
# getServiceName( )

Return service name.

Return service name.

Returns

string|null
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setSrcDir( string $srcDir )

Set absolute path to src directory to include coverage report.

Set absolute path to src directory to include coverage report.

Parameters

$srcDir
string
$srcDir

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public string
# getSrcDir( )

Return absolute path to src directory to include coverage report.

Return absolute path to src directory to include coverage report.

Returns

string
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setCloverXmlPaths( array $cloverXmlPaths )

Set absolute paths to clover.xml.

Set absolute paths to clover.xml.

Parameters

$cloverXmlPaths
string
$cloverXmlPaths

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# addCloverXmlPath( string $cloverXmlPath )

Add absolute path to clover.xml.

Add absolute path to clover.xml.

Parameters

$cloverXmlPath
string
$cloverXmlPath

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public string
# getCloverXmlPaths( )

Return absolute path to clover.xml.

Return absolute path to clover.xml.

Returns

string
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setJsonPath( string $jsonPath )

Set absolute path to output json_file.

Set absolute path to output json_file.

Parameters

$jsonPath
string
$jsonPath

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public string
# getJsonPath( )

Return absolute path to output json_file.

Return absolute path to output json_file.

Returns

string
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setDryRun( boolean $dryRun )

Set whether to send json_file to jobs API.

Set whether to send json_file to jobs API.

Parameters

$dryRun
boolean
$dryRun

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public boolean
# isDryRun( )

Return whether to send json_file to jobs API.

Return whether to send json_file to jobs API.

Returns

boolean
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setExcludeNoStatements( boolean $excludeNoStatements )

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

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

Parameters

$excludeNoStatements
boolean
$excludeNoStatements

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setExcludeNoStatementsUnlessFalse( boolean $excludeNoStatements )

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

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

Parameters

$excludeNoStatements
boolean
$excludeNoStatements

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public boolean
# isExcludeNoStatements( )

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

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

Returns

boolean
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setVerbose( boolean $verbose )

Set whether to show log.

Set whether to show log.

Parameters

$verbose
boolean
$verbose

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public boolean
# isVerbose( )

Return whether to show log.

Return whether to show log.

Returns

boolean
public Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# setEnv( string $env )

Set runtime environment name.

Set runtime environment name.

Parameters

$env
string
$env Runtime environment name.

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
public string
# getEnv( )

Return runtime environment name.

Return runtime environment name.

Returns

string
public boolean
# isTestEnv( )

Return whether the runtime environment is test.

Return whether the runtime environment is test.

Returns

boolean
public boolean
# isDevEnv( )

Return whether the runtime environment is dev.

Return whether the runtime environment is dev.

Returns

boolean
public boolean
# isProdEnv( )

Return whether the runtime environment is prod.

Return whether the runtime environment is prod.

Returns

boolean
Properties summary
protected string $repoToken
#

repo_token.

repo_token.

protected string $serviceName
#

service_name.

service_name.

protected string $srcDir
#

Absolute path to src directory to include coverage report.

Absolute path to src directory to include coverage report.

protected array $cloverXmlPaths array()
#

Absolute paths to clover.xml.

Absolute paths to clover.xml.

protected string $jsonPath
#

Absolute path to output json_file.

Absolute path to output json_file.

protected boolean $dryRun true
#

Whether to send json_file to jobs API.

Whether to send json_file to jobs API.

protected boolean $excludeNoStatements false
#

Whether to exclude source files that have no executable statements.

Whether to exclude source files that have no executable statements.

protected boolean $verbose false
#

Whether to show log.

Whether to show log.

protected string $env 'prod'
#

Runtime environment name.

Runtime environment name.

php-coveralls API documentation generated by ApiGen 2.8.0