Jobs
extends CoverallsApi
in package
Jobs API.
Tags
Table of Contents
Constants
Properties
Methods
- __construct() : mixed
- Constructor.
- collectCloverXml() : $this
- Collect clover XML into json_file.
- collectEnvVars() : $this
- Collect environment variables.
- collectGitInfo() : $this
- Collect git repository info into json_file.
- dumpJsonFile() : $this
- Dump uploading json file.
- getConfiguration() : Configuration
- Return configuration.
- getHttpClient() : Client
- Return HTTP client.
- getJsonFile() : null|JsonFile
- Return JsonFile.
- send() : null|Response
- Send json_file to jobs API.
- setHttpClient() : $this
- Set HTTP client.
- setJsonFile() : $this
- Set JsonFile.
- upload() : Response
- Upload a file.
Constants
FILENAME
Filename as a POST parameter.
public
string
FILENAME
= 'json_file'
URL
URL for jobs API.
public
string
URL
= '/api/v1/jobs'
Properties
$client
HTTP client.
protected
Client
$client
$config
Configuration.
protected
Configuration
$config
$jsonFile
JsonFile.
protected
JsonFile
$jsonFile
Methods
__construct()
Constructor.
public
__construct(Configuration $config[, Client $client = null ]) : mixed
Parameters
- $config : Configuration
-
configuration
- $client : Client = null
-
hTTP client
collectCloverXml()
Collect clover XML into json_file.
public
collectCloverXml() : $this
Return values
$thiscollectEnvVars()
Collect environment variables.
public
collectEnvVars(array<string|int, mixed> $env) : $this
Parameters
- $env : array<string|int, mixed>
-
$_SERVER environment
Tags
Return values
$thiscollectGitInfo()
Collect git repository info into json_file.
public
collectGitInfo() : $this
Return values
$thisdumpJsonFile()
Dump uploading json file.
public
dumpJsonFile() : $this
Return values
$thisgetConfiguration()
Return configuration.
public
getConfiguration() : Configuration
Return values
ConfigurationgetHttpClient()
Return HTTP client.
public
getHttpClient() : Client
Return values
ClientgetJsonFile()
Return JsonFile.
public
getJsonFile() : null|JsonFile
Return values
null|JsonFilesend()
Send json_file to jobs API.
public
send() : null|Response
Return values
null|ResponsesetHttpClient()
Set HTTP client.
public
setHttpClient(Client $client) : $this
Parameters
- $client : Client
-
hTTP client
Return values
$thissetJsonFile()
Set JsonFile.
public
setJsonFile(JsonFile $jsonFile) : $this
Parameters
- $jsonFile : JsonFile
-
json_file content
Return values
$thisupload()
Upload a file.
protected
upload(string $url, string $path, string $filename) : Response
Parameters
- $url : string
-
uRL to upload
- $path : string
-
file path
- $filename : string
-
filename