class Preview

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

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\SystemDms\Docs\ClassGenerated\Model\Preview to the model to get access to the properties.

Properties

int $id
int $document_id
int $version_id
string $checksum
string $type
int $page_count
string $resolution
string $status:

in progress|done|failed

int $created_at:

stored in MySQL as timestamp

int $updated_at:

stored in MySQL as timestamp

Methods

Preview[]
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.

Preview[]
find_all_by_id(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 37
Preview[] all(mixed $sql_params)

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

Parameters

mixed $sql_params

Return Value

Preview[]

at line 37
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 37
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 37
Preview[] find_all_by_id(int $id, mixed $sql_params)

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

Parameters

int $id
mixed $sql_params

Return Value

Preview[]

at line 37
Preview 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

Preview