class AggregateDimensionDocumentation

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

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

Properties

int $id
int $instance_id
string $hook_name
string $dimension_group:

stored in MySQL as varchar

string $dimension_name:

stored in MySQL as varchar

string $dimension_title_i18n:

stored in MySQL as varchar

int $sort
bool $active:

stored in MySQL as tinyint

int $updated_at:

stored in MySQL as timestamp

int $created_at:

stored in MySQL as timestamp

Methods

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

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

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

Parameters

mixed $sql_params

Return Value

AggregateDimension[]

at line 33
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 33
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 33
AggregateDimension[] 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

AggregateDimension[]

at line 33
AggregateDimension 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

AggregateDimension