Add more annotations for Model properties.

computablefacts · Sep 11, 2024 · c3738d7 · c3738d7
1 parent 7ecdb29
commit c3738d7
Show file tree

Hide file tree

Showing 15 changed files with 155 additions and 0 deletions.
diff --git a/app/Models/Tenant.php b/app/Models/Tenant.php
@@ -5,6 +5,10 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @property int id
+ * @property string name
+ */
 class Tenant extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhApplication.php b/app/Models/YnhApplication.php
@@ -7,6 +7,17 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
+/**
+ * @property int id
+ * @property string name
+ * @property ?string description
+ * @property string version
+ * @property ?string path
+ * @property string sku
+ * @property int ynh_server_id
+ * @property ?int ynh_order_id
+ * @property bool updated
+ */
 class YnhApplication extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhBackup.php b/app/Models/YnhBackup.php
@@ -8,6 +8,15 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property int id
+ * @property ?int user_id
+ * @property int ynh_server_id
+ * @property string name
+ * @property int size
+ * @property ?string storage_path
+ * @property array result
+ */
 class YnhBackup extends Model
 {
     use HasFactory, HasTenant2;

diff --git a/app/Models/YnhDomain.php b/app/Models/YnhDomain.php
@@ -6,6 +6,13 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property int id
+ * @property string name
+ * @property bool is_principal
+ * @property int ynh_server_id
+ * @property bool updated
+ */
 class YnhDomain extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhNginxLogs.php b/app/Models/YnhNginxLogs.php
@@ -9,6 +9,16 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
 
+/**
+ * @property int id
+ * @property bool updated
+ * @property ?int from_ynh_server_id
+ * @property ?int to_ynh_server_id
+ * @property string from_ip_address
+ * @property string to_ip_address
+ * @property string service
+ * @property int weight
+ */
 class YnhNginxLogs extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhOrder.php b/app/Models/YnhOrder.php
@@ -10,6 +10,12 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Support\Collection;
 
+/**
+ * @property int id
+ * @property int order_id
+ * @property int order_item_id
+ * @property ProductTypeEnum product_type
+ */
 class YnhOrder extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhOsquery.php b/app/Models/YnhOsquery.php
@@ -2,12 +2,28 @@
 
 namespace App\Models;
 
+use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
 
+/**
+ * @property int id
+ * @property int ynh_server_id
+ * @property int row
+ * @property string name
+ * @property string host_identifier
+ * @property Carbon calendar_time
+ * @property int unix_time
+ * @property int epoch
+ * @property int counter
+ * @property bool numerics
+ * @property array columns
+ * @property string action
+ * @property bool packed
+ */
 class YnhOsquery extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhOsqueryDiskUsage.php b/app/Models/YnhOsqueryDiskUsage.php
@@ -2,10 +2,21 @@
 
 namespace App\Models;
 
+use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property int id
+ * @property int ynh_server_id
+ * @property Carbon timestamp
+ * @property double percent_available
+ * @property double percent_used
+ * @property double space_left_gb
+ * @property double total_space_gb
+ * @property double used_space_gb
+ */
 class YnhOsqueryDiskUsage extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhOsqueryMemoryUsage.php b/app/Models/YnhOsqueryMemoryUsage.php
@@ -2,10 +2,21 @@
 
 namespace App\Models;
 
+use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property int id
+ * @property int ynh_server_id
+ * @property Carbon timestamp
+ * @property double percent_available
+ * @property double percent_used
+ * @property double space_left_gb
+ * @property double total_space_gb
+ * @property double used_space_gb
+ */
 class YnhOsqueryMemoryUsage extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhOsqueryRule.php b/app/Models/YnhOsqueryRule.php
@@ -6,6 +6,19 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @property int id
+ * @property string name
+ * @property string description
+ * @property ?string value
+ * @property string query
+ * @property ?string version
+ * @property int interval
+ * @property bool removed
+ * @property bool snapshot
+ * @property OsqueryPlatformEnum platform
+ * @property ?string category
+ */
 class YnhOsqueryRule extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhPermission.php b/app/Models/YnhPermission.php
@@ -8,6 +8,16 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Support\Collection;
 
+/**
+ * @property int id
+ * @property string name
+ * @property int ynh_user_id
+ * @property int ynh_application_id
+ * @property bool updated
+ * @property bool is_visitors
+ * @property bool is_all_users
+ * @property bool is_user_specific
+ */
 class YnhPermission extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhServer.php b/app/Models/YnhServer.php
@@ -22,6 +22,24 @@
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
 
+/**
+ * @property int id
+ * @property string name
+ * @property ?string version
+ * @property ?string ip_address
+ * @property ?int ssh_port
+ * @property ?string ssh_username
+ * @property ?string ssh_public_key
+ * @property ?string ssh_private_key
+ * @property ?int user_id
+ * @property bool updated
+ * @property bool is_ready
+ * @property ?int ynh_order_id
+ * @property string secret
+ * @property string ip_address_v6
+ * @property bool is_frozen
+ * @property bool added_with_curl
+ */
 class YnhServer extends Model
 {
     use HasFactory, HasTenant2;

diff --git a/app/Models/YnhSshTraces.php b/app/Models/YnhSshTraces.php
@@ -8,6 +8,15 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property int id
+ * @property ?int user_id
+ * @property int ynh_server_id
+ * @property string uid
+ * @property int order
+ * @property SshTraceStateEnum state
+ * @property string trace
+ */
 class YnhSshTraces extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhTheCyberBrief.php b/app/Models/YnhTheCyberBrief.php
@@ -9,6 +9,18 @@
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
 
+/**
+ * @property int id
+ * @property string news
+ * @property LanguageEnum news_language
+ * @property ?string hyperlink
+ * @property ?string website
+ * @property ?string teaser
+ * @property ?string opener
+ * @property ?string why_it_matters
+ * @property ?string go_deeper
+ * @property bool is_published
+ */
 class YnhTheCyberBrief extends Model
 {
     use HasFactory;

diff --git a/app/Models/YnhUser.php b/app/Models/YnhUser.php
@@ -9,6 +9,14 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
 
+/**
+ * @property int id
+ * @property string username
+ * @property ?string fullname
+ * @property string email
+ * @property int ynh_server_id
+ * @property bool updated
+ */
 class YnhUser extends Model
 {
     use HasFactory;