1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Calendar
  7. \
  8. Docs
  9. \
  10. ClassGenerated
  11. \
  12. Model
  13. \
  14. Event

Event

class Event

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

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

Properties

int $id
int $calendar_id
int $user_id
string $start_date:

stored in MySQL as date
string $end_date:

stored in MySQL as date
int $start:

stored in MySQL as timestamp
int $end:

stored in MySQL as timestamp
string $title:

stored in MySQL as varchar
string $description:

stored in MySQL as text
string $location:

stored in MySQL as varchar
string $link:

stored in MySQL as varchar
string $rrule:

stored in MySQL as text
string $config:

stored in MySQL as text
string $remote_uid:

stored in MySQL as varchar
string $sync_id:

stored in MySQL as text
string $availability:

enum free|busy|with_reservations|absent
string $event_mode:

enum event_only|event_invitation|event_vote|event_vote_link|event_vote_closed
bool $private:

stored in MySQL as tinyint
bool $allday:

stored in MySQL as tinyint
string $access_token:

stored in MySQL as varchar
int $created_at:

stored in MySQL as timestamp
int $updated_at:

stored in MySQL as timestamp

Methods

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

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

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

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

Parameters

mixed $sql_params

Return Value

xm_calendar_event[]

at line 45
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 45
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 45
xm_calendar_event[] 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

xm_calendar_event[]

at line 45
xm_calendar_event 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

xm_calendar_event