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

ArticleDocumentation

class ArticleDocumentation

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

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

Properties

int $id
int $group_id
int $category_id
int $user_id
string $published_at:

stored in MySQL as datetime
string $auto_hide_time:

stored in MySQL as datetime
string $status:

enum draft|published
string $title_i18n:

stored in MySQL as varchar
string $summary_i18n:

stored in MySQL as text
string $body_plain_i18n:

stored in MySQL as mediumtext
string $body_rendered_i18n:

stored in MySQL as mediumtext
string $attachment1:

stored in MySQL as varchar
string $attachments:

stored in MySQL as text
string $show_attachments:

enum do not show|gallery|all attachments|files only
bool $show_carousel:

stored in MySQL as tinyint
string $image_config:

enum large|small
string $image_direction:

enum left|center|right
bool $topnews_enabled:

stored in MySQL as tinyint
bool $topnews_sort:

stored in MySQL as tinyint
int $created_at:

stored in MySQL as timestamp
int $updated_at:

stored in MySQL as timestamp
string $deleted_at

Methods

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

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

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

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

Parameters

mixed $sql_params

Return Value

Article[]

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

Article[]

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

Article