class CheckDocumentation

This file provides property and method documentation for the model Check.

This file is generated by the XELOS command line tool xf kickstart. It will be overwritten when new kickstart actions are performed.

Add @mixin \XELOS\Modules\SystemStatus\Docs\ClassGenerated\Model\CheckDocumentation to the model to get access to the properties.

Properties

int $id
string $instance_id:

stored in MySQL as varchar

string $check_id:

stored in MySQL as varchar

string $title:

stored in MySQL as varchar

string $icon:

stored in MySQL as varchar

int $node_id
string $state:

enum green|orange|red

string $message
string $details:

stored in MySQL as text

bool $active:

stored in MySQL as tinyint

int $updated_at:

stored in MySQL as timestamp

Methods

Check[]
all(mixed $sql_params)

Returns all models. Query params can be e.g. order_by

int
count_all(mixed $sql_params)

Returns the count

int
delete_by_id(int $id, mixed $sql_params)

Delete rows specified by condition and returns the affected rows.

Check[]
find_all_by_id(int|int[] $id, mixed $sql_params)

Returns the first model with the given id. Query params can be e.g. order_by

find_by_id(int|int[] $id, mixed $sql_params)

Returns all models by id and ids. Query params can be e.g. order_by

Details

at line 34
Check[] all(mixed $sql_params)

Returns all models. Query params can be e.g. order_by

Parameters

mixed $sql_params

Return Value

Check[]

at line 34
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 34
int delete_by_id(int $id, mixed $sql_params)

Delete rows specified by condition and returns the affected rows.

Parameters

int $id
mixed $sql_params

Return Value

int

at line 34
Check[] find_all_by_id(int|int[] $id, mixed $sql_params)

Returns the first model with the given id. Query params can be e.g. order_by

Parameters

int|int[] $id
mixed $sql_params

Return Value

Check[]

at line 34
Check find_by_id(int|int[] $id, mixed $sql_params)

Returns all models by id and ids. Query params can be e.g. order_by

Parameters

int|int[] $id
mixed $sql_params

Return Value

Check