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 Configurator

Coveralls API configurator.

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

Load configuration.

Load configuration.

Parameters

$coverallsYmlPath
string
$coverallsYmlPath Path to .coveralls.yml.
$rootDir
string
$rootDir Path to project root directory.

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
protected array
# parse( string $coverallsYmlPath )

Parse .coveralls.yml.

Parse .coveralls.yml.

Parameters

$coverallsYmlPath
string
$coverallsYmlPath Path to .coveralls.yml.

Returns

array
protected array
# process( array $yml )

Process parsed configuration according to the configuration definition.

Process parsed configuration according to the configuration definition.

Parameters

$yml
array
$yml Parsed configuration.

Returns

array
protected Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
# createConfiguration( array $options, string $rootDir )

Create coveralls configuration.

Create coveralls configuration.

Parameters

$options
array
$options Processed configuration.
$rootDir
string
$rootDir Path to project root directory.

Returns

Contrib\Bundle\CoverallsV1Bundle\Config\Configuration
protected string
# ensureSrcDir( string $option, string $rootDir, Contrib\Component\File\Path $file )

Ensure src_dir is valid.

Ensure src_dir is valid.

Parameters

$option
string
$option src_dir option.
$rootDir
string
$rootDir Path to project root directory.
$file
Contrib\Component\File\Path
$file Path object.

Returns

string
Valid src_dir.

Throws

Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
protected array
# ensureCloverXmlPaths( string $option, string $rootDir, Contrib\Component\File\Path $file )

Ensure coverage_clover is valid.

Ensure coverage_clover is valid.

Parameters

$option
string
$option coverage_clover option.
$rootDir
string
$rootDir Path to project root directory.
$file
Contrib\Component\File\Path
$file Path object.

Returns

array
Valid Absolute pathes of coverage_clover.

Throws

Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
protected array
# getGlobPaths( string $path )

Return absolute paths from glob path.

Return absolute paths from glob path.

Parameters

$path
string
$path Absolute path.

Returns

array
Absolute paths.

Throws

Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
protected array
# getGlobPathsFromStringOption( string $option, string $rootDir, Contrib\Component\File\Path $file )

Return absolute paths from string option value.

Return absolute paths from string option value.

Parameters

$option
string
$option coverage_clover option value.
$rootDir
string
$rootDir Path to project root directory.
$file
Contrib\Component\File\Path
$file Path object.

Returns

array
Absolute pathes.

Throws

Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
protected array
# getGlobPathsFromArrayOption( array $options, string $rootDir, Contrib\Component\File\Path $file )

Return absolute paths from array option values.

Return absolute paths from array option values.

Parameters

$options
array
$options coverage_clover option values.
$rootDir
string
$rootDir Path to project root directory.
$file
Contrib\Component\File\Path
$file Path object.

Returns

array
Absolute pathes.
protected string
# ensureJsonPath( string $option, string $rootDir, Contrib\Component\File\Path $file )

Ensure json_path is valid.

Ensure json_path is valid.

Parameters

$option
string
$option json_path option.
$rootDir
string
$rootDir Path to project root directory.
$file
Contrib\Component\File\Path
$file Path object.

Returns

string
Valid json_path.

Throws

Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
php-coveralls API documentation generated by ApiGen 2.8.0