class TaskDocumentation

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

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

Properties

int $id
int $list_id
int $user_id
string $contributor_ids:

stored in MySQL as text

string $checklist:

stored in MySQL as text

int $group_id
string $parent
string $type:

enum open|closed

string $title:

stored in MySQL as varchar

string $description:

stored in MySQL as text

int $responsible
int $deadline:

stored in MySQL as timestamp

string $priority:

enum low|medium|high|auto

string $status:

stored in MySQL as varchar

string $attachments:

stored in MySQL as text

int $sort
int $category_num
int $personal_sort
int $personal_category_num
int $finished_by
int $finished_at:

stored in MySQL as timestamp

int $created_by
int $created_at:

stored in MySQL as timestamp

int $updated_at:

stored in MySQL as timestamp

Methods

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

Task[]
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 47
Task[] all(mixed $sql_params)

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

Parameters

mixed $sql_params

Return Value

Task[]

at line 47
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 47
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 47
Task[] 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

Task[]

at line 47
Task 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

Task