class DocumentMetaField

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

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\DocumentMetaField to the model to get access to the properties.

Properties

int $id
int $template_id
string $label_i18n

: stored in MySQL as varchar

string $description_i18n

: stored in MySQL as varchar

string $type

: stored in MySQL as varchar

string $fdl

: stored in MySQL as text

string $format

: stored in MySQL as text

bool $show_as_hierarchy:

stored in MySQL as tinyint

bool $show_as_filter

: stored in MySQL as tinyint

int $sort
int $created_at

: stored in MySQL as timestamp

int $updated_at

: stored in MySQL as timestamp

Methods

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

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

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

Parameters

mixed $sql_params

Return Value

DocumentMetaField[]

at line 41
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 41
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 41
DocumentMetaField[] 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

DocumentMetaField[]

at line 41
DocumentMetaField 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

DocumentMetaField