class Newsletter

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

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

Properties

int $id
int $group_id
int $newsletter_group_id
int $api_id
string $status:

stored in MySQL as varchar

string|array $lists:

stored in MySQL as text

int $recipient_cnt
string $additional_recipients:

stored in MySQL as text

string $sender_name:

stored in MySQL as varchar

string $sender_email:

stored in MySQL as varchar

string $subject:

stored in MySQL as varchar

string $message:

stored in MySQL as text

string $attachment:

stored in MySQL as text

string $scheduled_at:

stored in MySQL as datetime

int $created_at:

stored in MySQL as timestamp

int $updated_at:

stored in MySQL as timestamp

Methods

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

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

Parameters

mixed $sql_params

Return Value

xmodel_groups_newsletter[]

at line 39
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 39
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 39
xmodel_groups_newsletter[] 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_groups_newsletter[]

at line 39
xmodel_groups_newsletter 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_groups_newsletter