Skip to content

Commit

Permalink
πŸ“ (Export.php): Update PHPDoc comments for Export model properties an…
Browse files Browse the repository at this point in the history
…d methods for better readability and documentation

πŸ“ (FailedImportRow.php): Update PHPDoc comments for FailedImportRow model properties and methods for better readability and documentation
πŸ“ (FailedJob.php): Update PHPDoc comments for FailedJob model properties and methods for better readability and documentation
πŸ“ (Frequency.php): Update PHPDoc comments for Frequency model properties and methods for better readability and documentation
πŸ“ (Import.php): Update PHPDoc comments for Import model properties and methods for better readability and documentation

πŸ“ (Job.php, JobBatch.php, JobManager.php, JobsWaiting.php): Update PHPDoc block comments for better readability and consistency in the Models directory. Add missing line breaks and align property types for improved code organization.

πŸ“ (Parameter.php): Update property annotations for better readability and consistency
πŸ“ (Result.php): Update property annotations for better readability and consistency
πŸ“ (Schedule.php): Update property annotations for better readability and consistency
πŸ“ (ScheduleHistory.php): Update property annotations for better readability and consistency

πŸ“ (Task.php): Improve code readability by aligning property types and descriptions in the Task model
πŸ”§ (Task.php): Fix comparison operator in autoCleanup method for better code consistency
  • Loading branch information
marco76tv committed Jul 1, 2024
2 parents 44241f9 + cf896a0 commit a411ac9
Show file tree
Hide file tree
Showing 14 changed files with 301 additions and 260 deletions.
35 changes: 18 additions & 17 deletions Models/Export.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,27 @@
use Illuminate\Database\Eloquent\Builder;

/**
*
*
* @method static \Modules\Job\Database\Factories\ExportFactory factory($count = null, $state = [])
* @method static Builder|Export newModelQuery()
* @method static Builder|Export newQuery()
* @method static Builder|Export query()
* @property int $id
* @method static Builder|Export newModelQuery()
* @method static Builder|Export newQuery()
* @method static Builder|Export query()
*
* @property int $id
* @property \Illuminate\Support\Carbon|null $completed_at
* @property string $file_disk
* @property string|null $file_name
* @property string $exporter
* @property int $processed_rows
* @property int $total_rows
* @property int $successful_rows
* @property string|null $user_id
* @property string $file_disk
* @property string|null $file_name
* @property string $exporter
* @property int $processed_rows
* @property int $total_rows
* @property int $successful_rows
* @property string|null $user_id
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property string|null $updated_by
* @property string|null $created_by
* @property string|null $deleted_at
* @property string|null $deleted_by
* @property string|null $updated_by
* @property string|null $created_by
* @property string|null $deleted_at
* @property string|null $deleted_by
*
* @method static Builder|Export whereCompletedAt($value)
* @method static Builder|Export whereCreatedAt($value)
* @method static Builder|Export whereCreatedBy($value)
Expand All @@ -47,6 +47,7 @@
* @method static Builder|Export whereUpdatedAt($value)
* @method static Builder|Export whereUpdatedBy($value)
* @method static Builder|Export whereUserId($value)
*
* @mixin \Eloquent
*/
class Export extends BaseModel
Expand Down
23 changes: 12 additions & 11 deletions Models/FailedImportRow.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@
use Illuminate\Database\Eloquent\Builder;

/**
*
*
* @method static \Modules\Job\Database\Factories\FailedImportRowFactory factory($count = null, $state = [])
* @method static Builder|FailedImportRow newModelQuery()
* @method static Builder|FailedImportRow newQuery()
* @method static Builder|FailedImportRow query()
* @property int $id
* @property array $data
* @property int $import_id
* @property string|null $validation_error
* @method static Builder|FailedImportRow newModelQuery()
* @method static Builder|FailedImportRow newQuery()
* @method static Builder|FailedImportRow query()
*
* @property int $id
* @property array $data
* @property int $import_id
* @property string|null $validation_error
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property string|null $updated_by
* @property string|null $created_by
* @property string|null $updated_by
* @property string|null $created_by
*
* @method static Builder|FailedImportRow whereCreatedAt($value)
* @method static Builder|FailedImportRow whereCreatedBy($value)
* @method static Builder|FailedImportRow whereData($value)
Expand All @@ -33,6 +33,7 @@
* @method static Builder|FailedImportRow whereUpdatedAt($value)
* @method static Builder|FailedImportRow whereUpdatedBy($value)
* @method static Builder|FailedImportRow whereValidationError($value)
*
* @mixin \Eloquent
*/
class FailedImportRow extends BaseModel
Expand Down
13 changes: 8 additions & 5 deletions Models/FailedJob.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,26 @@
* Modules\Job\Models\FailedJob.
*
* @method static \Modules\Job\Database\Factories\FailedJobFactory factory($count = null, $state = [])
* @method static Builder|FailedJob newModelQuery()
* @method static Builder|FailedJob newQuery()
* @method static Builder|FailedJob query()
* @property int $id
* @method static Builder|FailedJob newModelQuery()
* @method static Builder|FailedJob newQuery()
* @method static Builder|FailedJob query()
*
* @property int $id
* @property string $uuid
* @property string $connection
* @property string $queue
* @property array $payload
* @property array $payload
* @property string $exception
* @property string $failed_at
*
* @method static Builder|FailedJob whereConnection($value)
* @method static Builder|FailedJob whereException($value)
* @method static Builder|FailedJob whereFailedAt($value)
* @method static Builder|FailedJob whereId($value)
* @method static Builder|FailedJob wherePayload($value)
* @method static Builder|FailedJob whereQueue($value)
* @method static Builder|FailedJob whereUuid($value)
*
* @mixin \Eloquent
*/
class FailedJob extends BaseModel
Expand Down
44 changes: 23 additions & 21 deletions Models/Frequency.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,31 @@
/**
* Modules\Job\Models\Frequency.
*
* @property int $id
* @property int $task_id
* @property string $label
* @property string $interval
* @property string|null $created_by
* @property string|null $updated_by
* @property Carbon|null $created_at
* @property Carbon|null $updated_at
* @property int $id
* @property int $task_id
* @property string $label
* @property string $interval
* @property string|null $created_by
* @property string|null $updated_by
* @property Carbon|null $created_at
* @property Carbon|null $updated_at
* @property Collection<int, \Modules\Job\Models\Parameter> $parameters
* @property int|null $parameters_count
* @property Task|null $task
* @property int|null $parameters_count
* @property Task|null $task
*
* @method static \Modules\Job\Database\Factories\FrequencyFactory factory($count = null, $state = [])
* @method static Builder|Frequency newModelQuery()
* @method static Builder|Frequency newQuery()
* @method static Builder|Frequency query()
* @method static Builder|Frequency whereCreatedAt($value)
* @method static Builder|Frequency whereCreatedBy($value)
* @method static Builder|Frequency whereId($value)
* @method static Builder|Frequency whereInterval($value)
* @method static Builder|Frequency whereLabel($value)
* @method static Builder|Frequency whereTaskId($value)
* @method static Builder|Frequency whereUpdatedAt($value)
* @method static Builder|Frequency whereUpdatedBy($value)
* @method static Builder|Frequency newModelQuery()
* @method static Builder|Frequency newQuery()
* @method static Builder|Frequency query()
* @method static Builder|Frequency whereCreatedAt($value)
* @method static Builder|Frequency whereCreatedBy($value)
* @method static Builder|Frequency whereId($value)
* @method static Builder|Frequency whereInterval($value)
* @method static Builder|Frequency whereLabel($value)
* @method static Builder|Frequency whereTaskId($value)
* @method static Builder|Frequency whereUpdatedAt($value)
* @method static Builder|Frequency whereUpdatedBy($value)
*
* @mixin \Eloquent
*/
class Frequency extends BaseModel
Expand Down
37 changes: 20 additions & 17 deletions Models/Import.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,27 @@
use Illuminate\Database\Eloquent\Builder;

/**
*
*
* @method static \Modules\Job\Database\Factories\ImportFactory factory($count = null, $state = [])
* @method static Builder|Import newModelQuery()
* @method static Builder|Import newQuery()
* @method static Builder|Import query()
* @property int $id
* @method static Builder|Import newModelQuery()
* @method static Builder|Import newQuery()
* @method static Builder|Import query()
*
* @property int $id
* @property \Illuminate\Support\Carbon|null $completed_at
* @property string $file_name
* @property string $file_path
* @property string $importer
* @property int $processed_rows
* @property int $total_rows
* @property int $successful_rows
* @property string|null $user_id
* @property string $file_name
* @property string $file_path
* @property string $importer
* @property int $processed_rows
* @property int $total_rows
* @property int $successful_rows
* @property string|null $user_id
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property string|null $updated_by
* @property string|null $created_by
* @property string|null $deleted_at
* @property string|null $deleted_by
* @property string|null $updated_by
* @property string|null $created_by
* @property string|null $deleted_at
* @property string|null $deleted_by
*
* @method static Builder|Import whereCompletedAt($value)
* @method static Builder|Import whereCreatedAt($value)
* @method static Builder|Import whereCreatedBy($value)
Expand All @@ -47,8 +47,11 @@
* @method static Builder|Import whereUpdatedAt($value)
* @method static Builder|Import whereUpdatedBy($value)
* @method static Builder|Import whereUserId($value)
*
* @property string|null $user_type
*
* @method static Builder|Import whereUserType($value)
*
* @mixin \Eloquent
*/
class Import extends BaseModel
Expand Down
46 changes: 25 additions & 21 deletions Models/Job.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,39 +11,43 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Support\Carbon;
use Webmozart\Assert\Assert;

use function Safe\json_decode;

use Webmozart\Assert\Assert;

/**
* Modules\Job\Models\Job.
*
* @property int $id
* @property string $queue
* @property array $payload
* @property int $attempts
* @property int|null $reserved_at
* @property int $available_at
* @property Carbon $created_at
* @property int $id
* @property string $queue
* @property array $payload
* @property int $attempts
* @property int|null $reserved_at
* @property int $available_at
* @property Carbon $created_at
* @property string|null $created_by
* @property string|null $updated_by
* @property Carbon|null $updated_at
*
* @method static \Modules\Job\Database\Factories\JobFactory factory($count = null, $state = [])
* @method static Builder|Job newModelQuery()
* @method static Builder|Job newQuery()
* @method static Builder|Job query()
* @method static Builder|Job whereAttempts($value)
* @method static Builder|Job whereAvailableAt($value)
* @method static Builder|Job whereCreatedAt($value)
* @method static Builder|Job whereCreatedBy($value)
* @method static Builder|Job whereId($value)
* @method static Builder|Job wherePayload($value)
* @method static Builder|Job whereQueue($value)
* @method static Builder|Job whereReservedAt($value)
* @method static Builder|Job whereUpdatedAt($value)
* @method static Builder|Job whereUpdatedBy($value)
* @method static Builder|Job newModelQuery()
* @method static Builder|Job newQuery()
* @method static Builder|Job query()
* @method static Builder|Job whereAttempts($value)
* @method static Builder|Job whereAvailableAt($value)
* @method static Builder|Job whereCreatedAt($value)
* @method static Builder|Job whereCreatedBy($value)
* @method static Builder|Job whereId($value)
* @method static Builder|Job wherePayload($value)
* @method static Builder|Job whereQueue($value)
* @method static Builder|Job whereReservedAt($value)
* @method static Builder|Job whereUpdatedAt($value)
* @method static Builder|Job whereUpdatedBy($value)
*
* @property mixed $display_name
* @property mixed $status
*
* @mixin \Eloquent
*/
class Job extends BaseModel
Expand Down
46 changes: 24 additions & 22 deletions Models/JobBatch.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,32 @@
/**
* Modules\Job\Models\JobBatch.
*
* @property string $id
* @property string $name
* @property int $total_jobs
* @property int $pending_jobs
* @property int $failed_jobs
* @property string $failed_job_ids
* @property string $id
* @property string $name
* @property int $total_jobs
* @property int $pending_jobs
* @property int $failed_jobs
* @property string $failed_job_ids
* @property Collection|null $options
* @property Carbon|null $cancelled_at
* @property Carbon $created_at
* @property Carbon|null $finished_at
* @property Carbon|null $cancelled_at
* @property Carbon $created_at
* @property Carbon|null $finished_at
*
* @method static \Modules\Job\Database\Factories\JobBatchFactory factory($count = null, $state = [])
* @method static Builder|JobBatch newModelQuery()
* @method static Builder|JobBatch newQuery()
* @method static Builder|JobBatch query()
* @method static Builder|JobBatch whereCancelledAt($value)
* @method static Builder|JobBatch whereCreatedAt($value)
* @method static Builder|JobBatch whereFailedJobIds($value)
* @method static Builder|JobBatch whereFailedJobs($value)
* @method static Builder|JobBatch whereFinishedAt($value)
* @method static Builder|JobBatch whereId($value)
* @method static Builder|JobBatch whereName($value)
* @method static Builder|JobBatch whereOptions($value)
* @method static Builder|JobBatch wherePendingJobs($value)
* @method static Builder|JobBatch whereTotalJobs($value)
* @method static Builder|JobBatch newModelQuery()
* @method static Builder|JobBatch newQuery()
* @method static Builder|JobBatch query()
* @method static Builder|JobBatch whereCancelledAt($value)
* @method static Builder|JobBatch whereCreatedAt($value)
* @method static Builder|JobBatch whereFailedJobIds($value)
* @method static Builder|JobBatch whereFailedJobs($value)
* @method static Builder|JobBatch whereFinishedAt($value)
* @method static Builder|JobBatch whereId($value)
* @method static Builder|JobBatch whereName($value)
* @method static Builder|JobBatch whereOptions($value)
* @method static Builder|JobBatch wherePendingJobs($value)
* @method static Builder|JobBatch whereTotalJobs($value)
*
* @mixin \Eloquent
*/
class JobBatch extends BaseModel
Expand Down
Loading

0 comments on commit a411ac9

Please sign in to comment.