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

JobDocumentation

class JobDocumentation

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

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

Properties

int $id
string $id_token:

stored in MySQL as varchar
string $queue:

stored in MySQL as varchar
int $user_id
string $job_class:

stored in MySQL as varchar
string $job_data:

stored in MySQL as mediumblob
string $reference_id:

stored in MySQL as varchar
string $job_uniqueness_hash:

stored in MySQL as varchar
string $status:

enum new|processing|finished|canceled|error
string $status_message:

stored in MySQL as varchar
int $status_progress
string $error_message:

stored in MySQL as text
string $owner_thread:

stored in MySQL as varchar
int $retry_count
int $duration
string|int $created_at:

stored in MySQL as datetime
string|int $scheduled_at:

stored in MySQL as datetime
string|int $started_at:

stored in MySQL as datetime
string|int $finished_at:

stored in MySQL as datetime

Methods

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

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

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

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

Parameters

mixed $sql_params

Return Value

Job[]

at line 42
int count_all(mixed $sql_params)

Returns the count

Parameters

mixed $sql_params

Return Value

int

at line 42
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 42
Job[] 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

Job[]

at line 42
Job 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

Job