ListDocumentation
class ListDocumentation
This file provides property and method documentation for the model list.
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\Lists\Docs\ClassGenerated\Model\ListDocumentation to the model to get access to the properties.
Properties
| int | $id | ||
| string | $title: | stored in MySQL as varchar |
|
| int | $start_status_id | ||
| int | $group_id | ||
| int | $category_id | ||
| bool | $as_template: | stored in MySQL as tinyint |
|
| int | $template_id | ||
| bool | $active: | stored in MySQL as tinyint |
|
| string | $form_identifier: | stored in MySQL as varchar |
|
| string | $form_description: | stored in MySQL as text |
|
| string | $form_struct: | stored in MySQL as text |
|
| bool | $form_link: | stored in MySQL as tinyint |
|
| string | $form_process: | stored in MySQL as varchar |
|
| string | $action_link_label: | stored in MySQL as varchar |
|
| string | $action_link_url: | stored in MySQL as varchar |
|
| string | $process_email_subject: | stored in MySQL as varchar |
|
| string | $process_email_recipients: | stored in MySQL as text |
|
| int | $process_workflow_id | ||
| bool | $show_workflow_status: | stored in MySQL as tinyint |
|
| int | $user_id | ||
| int | $item_count | ||
| int | $created_at: | stored in MySQL as timestamp |
|
| int | $updated_at: | stored in MySQL as timestamp |
Methods
Returns all models. Query params can be e.g. order_by
Returns the count
Delete rows specified by condition and returns the affected rows.
Returns the first model with the given id. Query params can be e.g. order_by
Returns all models by id and ids. Query params can be e.g. order_by
Details
at line 47
xmodel_lists_list[]
all(mixed $sql_params)
Returns all models. Query params can be e.g. order_by
at line 47
int
count_all(mixed $sql_params)
Returns the count
at line 47
int
delete_by_id(int $id, mixed $sql_params)
Delete rows specified by condition and returns the affected rows.
at line 47
xmodel_lists_list[]
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
at line 47
xmodel_lists_list
find_by_id(int|int[] $id, mixed $sql_params)
Returns all models by id and ids. Query params can be e.g. order_by