1. class
  2. Hypervel
  3. \
  4. Doctor
  5. \
  6. Renderers
  7. \
  8. GithubRenderer

GithubRenderer

class GithubRenderer

Methods

array
annotations(DiagnosticReport $report)

Render the report as GitHub Actions workflow annotations.

string
level(DiagnosticOutcome $outcome)

Get the annotation level for a diagnostic outcome.

string
title(DiagnosticOutcome $outcome)

Build an annotation title.

string
summary(DiagnosticOutcome $outcome)

Build an annotation summary.

string
escapeProperty(string $value)

Escape a GitHub workflow command property value.

string
escapeData(string $value)

Escape a GitHub workflow command message body.

Details

at line 18
array annotations(DiagnosticReport $report)

Render the report as GitHub Actions workflow annotations.

Parameters

DiagnosticReport $report

Return Value

array

at line 41
protected string level(DiagnosticOutcome $outcome)

Get the annotation level for a diagnostic outcome.

Parameters

DiagnosticOutcome $outcome

Return Value

string

at line 53
protected string title(DiagnosticOutcome $outcome)

Build an annotation title.

Parameters

DiagnosticOutcome $outcome

Return Value

string

at line 61
protected string summary(DiagnosticOutcome $outcome)

Build an annotation summary.

Parameters

DiagnosticOutcome $outcome

Return Value

string

at line 83
protected string escapeProperty(string $value)

Escape a GitHub workflow command property value.

Parameters

string $value

Return Value

string

at line 95
protected string escapeData(string $value)

Escape a GitHub workflow command message body.

Parameters

string $value

Return Value

string