Back to Dagger

Check

docs/static/reference/php/Dagger/Check.html

0.20.73.5 KB
Original Source

Check

class Check extends AbstractObject implements IdAble

Properties

| | $lastQuery | | from AbstractObject |

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

bool

completed()

Whether the check completed

string

description()

The description of the check

Error

error()

If the check failed, this is the error

AbstractId

id()

A unique identifier for this Check.

string

name()

Return the fully qualified name of the check

Module

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

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 bool completed()

Whether the check completed

Return Value

| bool | |

at line 25 string description()

The description of the check

Return Value

| string | |

at line 34 Error error()

If the check failed, this is the error

Return Value

| Error | |

at line 43 AbstractId id()

A unique identifier for this Check.

Return Value

| AbstractId | |

at line 52 string name()

Return the fully qualified name of the check

Return Value

| string | |

at line 61 Module originalModule()

The original module in which the check has been defined

Return Value

| Module | |

at line 70 bool passed()

Whether the check passed

Return Value

| bool | |

at line 79 array path()

The path of the check within its module

Return Value

| array | |

at line 88 string resultEmoji()

An emoji representing the result of the check

Return Value

| string | |

at line 97 Check run()

Execute the check

Return Value

| Check | |

Generated by Doctum, a API Documentation generator and fork of Sami.