From 7c25fc2a9d4d3ab49a98cd633de4948ce4bf16ce Mon Sep 17 00:00:00 2001 From: Lance Pioch Date: Sat, 15 Jun 2024 05:39:53 -0400 Subject: [PATCH] Revert these doc blocks --- app/Models/ActivityLog.php | 36 ++++++++++++++++++++++++++++ app/Models/ActivityLogSubject.php | 16 +++++++++++++ app/Models/Backup.php | 19 +++++++++++++++ app/Models/Database.php | 14 +++++++++++ app/Models/DatabaseHost.php | 12 ++++++++++ app/Models/Egg.php | 39 +++++++++++++++++++++++++++++++ app/Models/EggVariable.php | 21 +++++++++++++++++ app/Models/Mount.php | 13 +++++++++++ app/Models/Node.php | 30 ++++++++++++++++++++++++ app/Models/RecoveryToken.php | 7 ++++++ app/Models/Schedule.php | 19 +++++++++++++++ app/Models/ServerTransfer.php | 17 ++++++++++++++ app/Models/ServerVariable.php | 10 ++++++++ app/Models/Setting.php | 7 ++++++ app/Models/Subuser.php | 10 ++++++++ app/Models/Task.php | 14 +++++++++++ app/Models/UserSSHKey.php | 32 +++++++++++++++++++++++++ 17 files changed, 316 insertions(+) diff --git a/app/Models/ActivityLog.php b/app/Models/ActivityLog.php index 06b9824ad..06fd2d108 100644 --- a/app/Models/ActivityLog.php +++ b/app/Models/ActivityLog.php @@ -12,6 +12,42 @@ use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\MorphTo; use Illuminate\Database\Eloquent\Model as IlluminateModel; +/** + * \App\Models\ActivityLog. + * + * @property int $id + * @property string|null $batch + * @property string $event + * @property string $ip + * @property string|null $description + * @property string|null $actor_type + * @property int|null $actor_id + * @property int|null $api_key_id + * @property \Illuminate\Support\Collection|null $properties + * @property \Carbon\Carbon $timestamp + * @property IlluminateModel|\Eloquent $actor + * @property \Illuminate\Database\Eloquent\Collection|\App\Models\ActivityLogSubject[] $subjects + * @property int|null $subjects_count + * @property \App\Models\ApiKey|null $apiKey + * + * @method static Builder|ActivityLog forActor(\Illuminate\Database\Eloquent\Model $actor) + * @method static Builder|ActivityLog forEvent(string $action) + * @method static Builder|ActivityLog newModelQuery() + * @method static Builder|ActivityLog newQuery() + * @method static Builder|ActivityLog query() + * @method static Builder|ActivityLog whereActorId($value) + * @method static Builder|ActivityLog whereActorType($value) + * @method static Builder|ActivityLog whereApiKeyId($value) + * @method static Builder|ActivityLog whereBatch($value) + * @method static Builder|ActivityLog whereDescription($value) + * @method static Builder|ActivityLog whereEvent($value) + * @method static Builder|ActivityLog whereId($value) + * @method static Builder|ActivityLog whereIp($value) + * @method static Builder|ActivityLog whereProperties($value) + * @method static Builder|ActivityLog whereTimestamp($value) + * + * @mixin \Eloquent + */ class ActivityLog extends Model { use MassPrunable; diff --git a/app/Models/ActivityLogSubject.php b/app/Models/ActivityLogSubject.php index 45b2c4ffe..037d344f0 100644 --- a/app/Models/ActivityLogSubject.php +++ b/app/Models/ActivityLogSubject.php @@ -6,6 +6,22 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\Relations\Pivot; use Illuminate\Database\Eloquent\SoftDeletes; +/** + * \App\Models\ActivityLogSubject. + * + * @property int $id + * @property int $activity_log_id + * @property int $subject_id + * @property string $subject_type + * @property \App\Models\ActivityLog|null $activityLog + * @property \Illuminate\Database\Eloquent\Model|\Eloquent $subject + * + * @method static \Illuminate\Database\Eloquent\Builder|ActivityLogSubject newModelQuery() + * @method static \Illuminate\Database\Eloquent\Builder|ActivityLogSubject newQuery() + * @method static \Illuminate\Database\Eloquent\Builder|ActivityLogSubject query() + * + * @mixin \Eloquent + */ class ActivityLogSubject extends Pivot { public $incrementing = true; diff --git a/app/Models/Backup.php b/app/Models/Backup.php index 48ab758b9..3f2a931d1 100644 --- a/app/Models/Backup.php +++ b/app/Models/Backup.php @@ -6,6 +6,25 @@ use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\SoftDeletes; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $server_id + * @property string $uuid + * @property bool $is_successful + * @property bool $is_locked + * @property string $name + * @property string[] $ignored_files + * @property string $disk + * @property string|null $checksum + * @property int $bytes + * @property string|null $upload_id + * @property \Carbon\CarbonImmutable|null $completed_at + * @property \Carbon\CarbonImmutable $created_at + * @property \Carbon\CarbonImmutable $updated_at + * @property \Carbon\CarbonImmutable|null $deleted_at + * @property \App\Models\Server $server + * @property \App\Models\AuditLog[] $audits + */ class Backup extends Model { use SoftDeletes; diff --git a/app/Models/Database.php b/app/Models/Database.php index 5270257f7..bd6bc6de3 100644 --- a/app/Models/Database.php +++ b/app/Models/Database.php @@ -5,6 +5,20 @@ namespace App\Models; use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Support\Facades\DB; +/** + * @property int $id + * @property int $server_id + * @property int $database_host_id + * @property string $database + * @property string $username + * @property string $remote + * @property string $password + * @property int $max_connections + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property \App\Models\Server $server + * @property \App\Models\DatabaseHost $host + */ class Database extends Model { /** diff --git a/app/Models/DatabaseHost.php b/app/Models/DatabaseHost.php index e2ee4b322..159e17261 100644 --- a/app/Models/DatabaseHost.php +++ b/app/Models/DatabaseHost.php @@ -5,6 +5,18 @@ namespace App\Models; use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property string $name + * @property string $host + * @property int $port + * @property string $username + * @property string $password + * @property int|null $max_databases + * @property int|null $node_id + * @property \Carbon\CarbonImmutable $created_at + * @property \Carbon\CarbonImmutable $updated_at + */ class DatabaseHost extends Model { /** diff --git a/app/Models/Egg.php b/app/Models/Egg.php index 0bf0a750e..bf90c9e12 100644 --- a/app/Models/Egg.php +++ b/app/Models/Egg.php @@ -8,6 +8,45 @@ use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Support\Str; +/** + * @property int $id + * @property string $uuid + * @property string $author + * @property string $name + * @property string|null $description + * @property array|null $features + * @property string $docker_image -- deprecated, use $docker_images + * @property array $docker_images + * @property string $update_url + * @property bool $force_outgoing_ip + * @property array|null $file_denylist + * @property string|null $config_files + * @property string|null $config_startup + * @property string|null $config_logs + * @property string|null $config_stop + * @property int|null $config_from + * @property string|null $startup + * @property bool $script_is_privileged + * @property string|null $script_install + * @property string $script_entry + * @property string $script_container + * @property int|null $copy_script_from + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property string|null $copy_script_install + * @property string $copy_script_entry + * @property string $copy_script_container + * @property string|null $inherit_config_files + * @property string|null $inherit_config_startup + * @property string|null $inherit_config_logs + * @property string|null $inherit_config_stop + * @property string $inherit_file_denylist + * @property array|null $inherit_features + * @property \Illuminate\Database\Eloquent\Collection|\App\Models\Server[] $servers + * @property \Illuminate\Database\Eloquent\Collection|\App\Models\EggVariable[] $variables + * @property \App\Models\Egg|null $scriptFrom + * @property \App\Models\Egg|null $configFrom + */ class Egg extends Model { /** diff --git a/app/Models/EggVariable.php b/app/Models/EggVariable.php index 40c901a38..f847efd84 100644 --- a/app/Models/EggVariable.php +++ b/app/Models/EggVariable.php @@ -5,6 +5,27 @@ namespace App\Models; use Illuminate\Database\Eloquent\Relations\HasOne; use Illuminate\Database\Eloquent\Relations\HasMany; +/** + * @property int $id + * @property int $egg_id + * @property null $sort + * @property string $name + * @property string $description + * @property string $env_variable + * @property string $default_value + * @property bool $user_viewable + * @property bool $user_editable + * @property string $rules + * @property \Carbon\CarbonImmutable $created_at + * @property \Carbon\CarbonImmutable $updated_at + * @property bool $required + * @property \App\Models\Egg $egg + * @property \App\Models\ServerVariable $serverVariable + * + * The "server_value" variable is only present on the object if you've loaded this model + * using the server relationship. + * @property string|null $server_value + */ class EggVariable extends Model { /** diff --git a/app/Models/Mount.php b/app/Models/Mount.php index ea4294110..aa335b990 100644 --- a/app/Models/Mount.php +++ b/app/Models/Mount.php @@ -5,6 +5,19 @@ namespace App\Models; use Illuminate\Validation\Rules\NotIn; use Illuminate\Database\Eloquent\Relations\BelongsToMany; +/** + * @property int $id + * @property string $uuid + * @property string $name + * @property string $description + * @property string $source + * @property string $target + * @property bool $read_only + * @property bool $user_mountable + * @property \App\Models\Egg[]|\Illuminate\Database\Eloquent\Collection $eggs + * @property \App\Models\Node[]|\Illuminate\Database\Eloquent\Collection $nodes + * @property \App\Models\Server[]|\Illuminate\Database\Eloquent\Collection $servers + */ class Mount extends Model { /** diff --git a/app/Models/Node.php b/app/Models/Node.php index a933d16fe..72d01f8b9 100644 --- a/app/Models/Node.php +++ b/app/Models/Node.php @@ -12,6 +12,36 @@ use Illuminate\Notifications\Notifiable; use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\HasManyThrough; +/** + * @property int $id + * @property string $uuid + * @property bool $public + * @property string $name + * @property string|null $description + * @property string $fqdn + * @property string $scheme + * @property bool $behind_proxy + * @property bool $maintenance_mode + * @property int $memory + * @property int $memory_overallocate + * @property int $disk + * @property int $disk_overallocate + * @property int $cpu + * @property int $cpu_overallocate + * @property int $upload_size + * @property string $daemon_token_id + * @property string $daemon_token + * @property int $daemon_listen + * @property int $daemon_sftp + * @property string|null $daemon_sftp_alias + * @property string $daemon_base + * @property array $tags + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property \App\Models\Mount[]|\Illuminate\Database\Eloquent\Collection $mounts + * @property \App\Models\Server[]|\Illuminate\Database\Eloquent\Collection $servers + * @property \App\Models\Allocation[]|\Illuminate\Database\Eloquent\Collection $allocations + */ class Node extends Model { use Notifiable; diff --git a/app/Models/RecoveryToken.php b/app/Models/RecoveryToken.php index 731347d71..c4fe8c8ae 100644 --- a/app/Models/RecoveryToken.php +++ b/app/Models/RecoveryToken.php @@ -4,6 +4,13 @@ namespace App\Models; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $user_id + * @property string $token + * @property \Carbon\CarbonImmutable $created_at + * @property \App\Models\User $user + */ class RecoveryToken extends Model { /** diff --git a/app/Models/Schedule.php b/app/Models/Schedule.php index 5bee2998e..7042d25a4 100644 --- a/app/Models/Schedule.php +++ b/app/Models/Schedule.php @@ -7,6 +7,25 @@ use Carbon\CarbonImmutable; use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $server_id + * @property string $name + * @property string $cron_day_of_week + * @property string $cron_month + * @property string $cron_day_of_month + * @property string $cron_hour + * @property string $cron_minute + * @property bool $is_active + * @property bool $is_processing + * @property bool $only_when_online + * @property \Carbon\Carbon|null $last_run_at + * @property \Carbon\Carbon|null $next_run_at + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property \App\Models\Server $server + * @property \App\Models\Task[]|\Illuminate\Support\Collection $tasks + */ class Schedule extends Model { /** diff --git a/app/Models/ServerTransfer.php b/app/Models/ServerTransfer.php index e4772005c..abfef3eb6 100644 --- a/app/Models/ServerTransfer.php +++ b/app/Models/ServerTransfer.php @@ -5,6 +5,23 @@ namespace App\Models; use Illuminate\Database\Eloquent\Relations\HasOne; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $server_id + * @property int $old_node + * @property int $new_node + * @property int $old_allocation + * @property int $new_allocation + * @property array|null $old_additional_allocations + * @property array|null $new_additional_allocations + * @property bool|null $successful + * @property bool $archived + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property \App\Models\Server $server + * @property \App\Models\Node $oldNode + * @property \App\Models\Node $newNode + */ class ServerTransfer extends Model { /** diff --git a/app/Models/ServerVariable.php b/app/Models/ServerVariable.php index 1d8308eaf..0c7eeffc5 100644 --- a/app/Models/ServerVariable.php +++ b/app/Models/ServerVariable.php @@ -4,6 +4,16 @@ namespace App\Models; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $server_id + * @property int $variable_id + * @property string $variable_value + * @property \Carbon\CarbonImmutable|null $created_at + * @property \Carbon\CarbonImmutable|null $updated_at + * @property \App\Models\EggVariable $variable + * @property \App\Models\Server $server + */ class ServerVariable extends Model { /** diff --git a/app/Models/Setting.php b/app/Models/Setting.php index 63d9cd3c9..4d4087f7c 100644 --- a/app/Models/Setting.php +++ b/app/Models/Setting.php @@ -2,6 +2,13 @@ namespace App\Models; +/** + * App\Models\Setting. + * + * @property int $id + * @property string $key + * @property string $value + */ class Setting extends Model { /** diff --git a/app/Models/Subuser.php b/app/Models/Subuser.php index 3426f81cb..566c8a741 100644 --- a/app/Models/Subuser.php +++ b/app/Models/Subuser.php @@ -6,6 +6,16 @@ use Illuminate\Notifications\Notifiable; use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $user_id + * @property int $server_id + * @property array $permissions + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property \App\Models\User $user + * @property \App\Models\Server $server + */ class Subuser extends Model { use Notifiable; diff --git a/app/Models/Task.php b/app/Models/Task.php index 3f44b7799..6545ab5f5 100644 --- a/app/Models/Task.php +++ b/app/Models/Task.php @@ -5,6 +5,20 @@ namespace App\Models; use Illuminate\Database\Eloquent\Relations\HasOneThrough; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * @property int $id + * @property int $schedule_id + * @property int $sequence_id + * @property string $action + * @property string $payload + * @property int $time_offset + * @property bool $is_queued + * @property bool $continue_on_failure + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property \App\Models\Schedule $schedule + * @property \App\Models\Server $server + */ class Task extends Model { /** diff --git a/app/Models/UserSSHKey.php b/app/Models/UserSSHKey.php index ff544c521..1cafb2d8b 100644 --- a/app/Models/UserSSHKey.php +++ b/app/Models/UserSSHKey.php @@ -5,6 +5,38 @@ namespace App\Models; use Illuminate\Database\Eloquent\SoftDeletes; use Illuminate\Database\Eloquent\Relations\BelongsTo; +/** + * \App\Models\UserSSHKey. + * + * @property int $id + * @property int $user_id + * @property string $name + * @property string $fingerprint + * @property string $public_key + * @property \Illuminate\Support\Carbon|null $created_at + * @property \Illuminate\Support\Carbon|null $updated_at + * @property \Illuminate\Support\Carbon|null $deleted_at + * @property \App\Models\User $user + * + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey newModelQuery() + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey newQuery() + * @method static \Illuminate\Database\Query\Builder|UserSSHKey onlyTrashed() + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey query() + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey whereCreatedAt($value) + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey whereDeletedAt($value) + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey whereFingerprint($value) + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey whereId($value) + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey whereName($value) + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey wherePublicKey($value) + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey whereUpdatedAt($value) + * @method static \Illuminate\Database\Eloquent\Builder|UserSSHKey whereUserId($value) + * @method static \Illuminate\Database\Query\Builder|UserSSHKey withTrashed() + * @method static \Illuminate\Database\Query\Builder|UserSSHKey withoutTrashed() + * + * @mixin \Eloquent + * + * @method static \Database\Factories\UserSSHKeyFactory factory(...$parameters) + */ class UserSSHKey extends Model { use SoftDeletes;