class Check extends AbstractObject implements IdAble

Properties

$lastQuery from  AbstractObject

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

null|array|string|int|float|bool
queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

string
checkType()

The type of check: 'check' for annotated checks, 'generate' for generate-as-checks

bool
completed()

Whether the check completed

string
description()

The description of the check

error()

If the check failed, this is the error

id()

A unique identifier for this Check.

string
name()

Return the fully qualified name of the check

originalModule()

The original module in which the check has been defined

bool
passed()

Whether the check passed

array
path()

The path of the check within its module

string
resultEmoji()

An emoji representing the result of the check

run()

Execute the check

Details

in AbstractObject at line 13
__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

AbstractClient $client
QueryBuilderChain $queryBuilderChain

in AbstractObject at line 19
protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

QueryBuilder $leafQueryBuilder
string $leafKey

Return Value

null|array|string|int|float|bool

at line 16
string checkType()

The type of check: 'check' for annotated checks, 'generate' for generate-as-checks

Return Value

string

at line 25
bool completed()

Whether the check completed

Return Value

bool

at line 34
string description()

The description of the check

Return Value

string

at line 43
Error error()

If the check failed, this is the error

Return Value

Error

at line 52
AbstractId id()

A unique identifier for this Check.

Return Value

AbstractId

at line 61
string name()

Return the fully qualified name of the check

Return Value

string

at line 70
Module originalModule()

The original module in which the check has been defined

Return Value

Module

at line 79
bool passed()

Whether the check passed

Return Value

bool

at line 88
array path()

The path of the check within its module

Return Value

array

at line 97
string resultEmoji()

An emoji representing the result of the check

Return Value

string

at line 106
Check run()

Execute the check

Return Value

Check