1. class
  2. PCIT
  3. \
  4. GitHub
  5. \
  6. Service
  7. \
  8. Checks
  9. \
  10. RunData

RunData

class RunData

Properties

$repo_full_name
$name
$commit_id
$details_url
$external_id
$status
$started_at
$completed_at
$conclusion
string|null $title
string|null $summary
$text
$annotations
$images
$actions
$check_run_id

Methods

__construct(string $repo_full_name, string $name, string $commit_id, string $details_url, string $external_id, string $status, int $started_at = null, int $completed_at = null, string $conclusion = null, string $title = null, string $summary = null, string $text = null, array $annotations = null, array $images = null, array $actions = null)

No description

static array
createAnnotation(string $path, int $start_line, int $end_line, int $start_column, int $end_column, string $annotation_level, string $message, string $title = null, string $raw_details = null)

No description

static array
createImage(string $alt, string $image_url, string $caption)

No description

static array
createAction(string $label = 'Fix', string $identifier = 'fix_errors', string $description = 'Allow us to fix these errors for you')

No description

Details

at line 51
__construct(string $repo_full_name, string $name, string $commit_id, string $details_url, string $external_id, string $status, int $started_at = null, int $completed_at = null, string $conclusion = null, string $title = null, string $summary = null, string $text = null, array $annotations = null, array $images = null, array $actions = null)

Parameters

string $repo_full_name
string $name
string $commit_id
string $details_url
string $external_id
string $status
int $started_at
int $completed_at
string $conclusion
string $title
string $summary
string $text
array $annotations
array $images
array $actions

at line 99
static array createAnnotation(string $path, int $start_line, int $end_line, int $start_column, int $end_column, string $annotation_level, string $message, string $title = null, string $raw_details = null)

Parameters

string $path Required. The path of the file to add an annotation to. For example, assets/css/main.css.
int $start_line Required. The start line of the annotation.
int $end_line Required. The end line of the annotation.
int $start_column the start column of the annotation
int $end_column the end column of the annotation
string $annotation_level Required. The level of the annotation. Can be one of notice, warning, or failure.
string $message Required. A short description of the feedback for these lines of code. The maximum size is 64 KB.
string $title The title that represents the annotation. The maximum size is 255 characters.
string $raw_details Details about this annotation. The maximum size is 64 KB.

Return Value

array

at line 122
static array createImage(string $alt, string $image_url, string $caption)

Parameters

string $alt Required. The alternative text for the image.
string $image_url Required. The full URL of the image.
string $caption a short image description

Return Value

array

at line 136
static array createAction(string $label = 'Fix', string $identifier = 'fix_errors', string $description = 'Allow us to fix these errors for you')

Parameters

string $label
string $identifier
string $description

Return Value

array

See also