class SyncSetting

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

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

Properties

int $id
int $user_id
int $calendar_id
string $direction:

enum both|from_sync|to_sync

string $master_direction:

enum from_sync|to_sync

string $hook_name:

stored in MySQL as varchar

string $hook_identity_id:

stored in MySQL as text

bool $active:

stored in MySQL as tinyint

int $last_sync:

stored in MySQL as timestamp

string $sync_status:

enum initial|running|idle

string $last_error:

stored in MySQL as text

int $created_at:

stored in MySQL as timestamp

int $updated_at:

stored in MySQL as timestamp

Methods

xmodel_calendar_sync_setting[]
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_calendar_sync_setting[]
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

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

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

Parameters

mixed $sql_params

Return Value

xmodel_calendar_sync_setting[]

at line 36
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 36
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 36
xmodel_calendar_sync_setting[] 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

xmodel_calendar_sync_setting[]

at line 36
xmodel_calendar_sync_setting 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_calendar_sync_setting