class Component

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

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

Properties

int $id
int $group_id
int $partial_id
string $sort
string $component:

stored in MySQL as varchar

string $properties:

stored in MySQL as longtext

int $created_at:

stored in MySQL as timestamp

int $updated_at:

stored in MySQL as timestamp

Methods

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

xmodel_cms_component[]
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

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

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

Parameters

mixed $sql_params

Return Value

xmodel_cms_component[]

at line 31
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 31
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 31
xmodel_cms_component[] 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

xmodel_cms_component[]

at line 31
xmodel_cms_component 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

xmodel_cms_component