Documentation

CiEnvVarsCollector
in package

Environment variables collector for CI envrionment.

Tags
author

Kitamura Satoshi with.no.parachute@gmail.com

Table of Contents

Properties

$config  : Configuration
Configuration.
$env  : array<string|int, mixed>
Environment variables.
$readEnv  : array<string|int, mixed>
Read environment variables.

Methods

__construct()  : mixed
Constructor.
collect()  : array<string|int, mixed>
Collect environment variables.
getReadEnv()  : array<string|int, mixed>
Return read environment variables.
fillAppVeyor()  : $this
Fill AppVeyor environment variables.
fillCircleCi()  : $this
Fill CircleCI environment variables.
fillGithubActions()  : $this
Fill Github Actions environment variables.
fillJenkins()  : $this
Fill Jenkins environment variables.
fillLocal()  : $this
Fill local environment variables.
fillParallel()  : $this
Fill parallel for parallel jobs.
fillRepoToken()  : $this
Fill repo_token for unsupported CI service.
fillTravisCi()  : $this
Fill Travis CI environment variables.

Properties

$env

Environment variables.

protected array<string|int, mixed> $env

Overwritten through collection process.

$readEnv

Read environment variables.

protected array<string|int, mixed> $readEnv

Methods

collect()

Collect environment variables.

public collect(array<string|int, mixed> $env) : array<string|int, mixed>
Parameters
$env : array<string|int, mixed>

$_SERVER environment

Return values
array<string|int, mixed>

getReadEnv()

Return read environment variables.

public getReadEnv() : array<string|int, mixed>
Return values
array<string|int, mixed>

fillAppVeyor()

Fill AppVeyor environment variables.

protected fillAppVeyor() : $this

"APPVEYOR", "APPVEYOR_BUILD_NUMBER" must be set.

Return values
$this

fillCircleCi()

Fill CircleCI environment variables.

protected fillCircleCi() : $this

"CIRCLECI", "CIRCLE_WORKFLOW_ID" must be set.

Return values
$this

fillGithubActions()

Fill Github Actions environment variables.

protected fillGithubActions() : $this
Return values
$this

fillJenkins()

Fill Jenkins environment variables.

protected fillJenkins() : $this

"JENKINS_URL", "BUILD_NUMBER" must be set.

Return values
$this

fillLocal()

Fill local environment variables.

protected fillLocal() : $this

"COVERALLS_RUN_LOCALLY" must be set.

Return values
$this

fillParallel()

Fill parallel for parallel jobs.

protected fillParallel() : $this
Return values
$this

fillRepoToken()

Fill repo_token for unsupported CI service.

protected fillRepoToken() : $this

"COVERALLS_REPO_TOKEN" must be set.

Return values
$this

fillTravisCi()

Fill Travis CI environment variables.

protected fillTravisCi() : $this

"TRAVIS", "TRAVIS_BUILD_NUMBER", TRAVIS_JOB_ID" must be set.

Return values
$this

        
On this page

Search results