2015-12-08 23:33:33 +00:00
|
|
|
<?php
|
2016-12-07 22:46:38 +00:00
|
|
|
|
2015-12-08 23:33:33 +00:00
|
|
|
namespace Pterodactyl\Models;
|
|
|
|
|
2022-10-14 16:59:20 +00:00
|
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
2022-12-15 01:04:16 +00:00
|
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
2022-10-14 16:59:20 +00:00
|
|
|
|
2020-08-22 22:43:28 +00:00
|
|
|
/**
|
2021-01-28 04:52:11 +00:00
|
|
|
* @property int $id
|
|
|
|
* @property int $egg_id
|
|
|
|
* @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
|
2022-11-28 16:56:03 +00:00
|
|
|
* @property Egg $egg
|
2022-12-15 01:04:16 +00:00
|
|
|
* @property ServerVariable $serverVariables
|
2022-11-28 16:56:03 +00:00
|
|
|
* @property string $field_type
|
2020-08-22 22:43:28 +00:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*/
|
2020-04-04 06:22:35 +00:00
|
|
|
class EggVariable extends Model
|
2015-12-08 23:33:33 +00:00
|
|
|
{
|
2018-01-26 03:26:06 +00:00
|
|
|
/**
|
|
|
|
* The resource name for this model when it is transformed into an
|
|
|
|
* API representation using fractal.
|
|
|
|
*/
|
2021-01-23 20:33:34 +00:00
|
|
|
public const RESOURCE_NAME = 'egg_variable';
|
2018-01-26 03:26:06 +00:00
|
|
|
|
2017-08-09 04:24:55 +00:00
|
|
|
/**
|
|
|
|
* Reserved environment variable names.
|
|
|
|
*/
|
2021-01-23 20:33:34 +00:00
|
|
|
public const RESERVED_ENV_NAMES = 'SERVER_MEMORY,SERVER_IP,SERVER_PORT,ENV,HOME,USER,STARTUP,SERVER_UUID,UUID';
|
2017-08-09 04:24:55 +00:00
|
|
|
|
2022-10-14 16:59:20 +00:00
|
|
|
protected bool $immutableDates = true;
|
2020-08-22 22:43:28 +00:00
|
|
|
|
2015-12-08 23:33:33 +00:00
|
|
|
/**
|
|
|
|
* The table associated with the model.
|
|
|
|
*/
|
2017-10-07 04:57:53 +00:00
|
|
|
protected $table = 'egg_variables';
|
2015-12-08 23:33:33 +00:00
|
|
|
|
2016-02-15 20:21:28 +00:00
|
|
|
/**
|
|
|
|
* Fields that are not mass assignable.
|
|
|
|
*/
|
|
|
|
protected $guarded = ['id', 'created_at', 'updated_at'];
|
|
|
|
|
2017-03-12 23:38:50 +00:00
|
|
|
/**
|
2017-03-16 00:53:49 +00:00
|
|
|
* Cast values to correct type.
|
|
|
|
*/
|
2017-03-12 23:34:06 +00:00
|
|
|
protected $casts = [
|
2017-10-07 04:57:53 +00:00
|
|
|
'egg_id' => 'integer',
|
2020-08-22 22:43:28 +00:00
|
|
|
'user_viewable' => 'bool',
|
|
|
|
'user_editable' => 'bool',
|
2017-03-12 23:34:06 +00:00
|
|
|
];
|
2017-02-05 22:58:17 +00:00
|
|
|
|
2022-10-14 16:59:20 +00:00
|
|
|
public static array $validationRules = [
|
2017-10-07 04:57:53 +00:00
|
|
|
'egg_id' => 'exists:eggs,id',
|
2020-09-26 23:29:26 +00:00
|
|
|
'name' => 'required|string|between:1,191',
|
2018-02-17 19:37:53 +00:00
|
|
|
'description' => 'string',
|
2020-09-26 23:29:26 +00:00
|
|
|
'env_variable' => 'required|regex:/^[\w]{1,191}$/|notIn:' . self::RESERVED_ENV_NAMES,
|
2017-08-09 04:24:55 +00:00
|
|
|
'default_value' => 'string',
|
|
|
|
'user_viewable' => 'boolean',
|
|
|
|
'user_editable' => 'boolean',
|
2019-09-05 05:19:57 +00:00
|
|
|
'rules' => 'required|string',
|
2017-08-09 04:24:55 +00:00
|
|
|
];
|
|
|
|
|
|
|
|
protected $attributes = [
|
|
|
|
'user_editable' => 0,
|
|
|
|
'user_viewable' => 0,
|
|
|
|
];
|
2017-05-01 21:01:46 +00:00
|
|
|
|
2022-10-14 16:59:20 +00:00
|
|
|
public function getRequiredAttribute(): bool
|
2020-08-22 22:43:28 +00:00
|
|
|
{
|
|
|
|
return in_array('required', explode('|', $this->rules));
|
|
|
|
}
|
|
|
|
|
2022-12-15 01:04:16 +00:00
|
|
|
/**
|
|
|
|
* Returns the egg that this variable belongs to.
|
|
|
|
*/
|
|
|
|
public function egg(): BelongsTo
|
2017-03-12 23:34:06 +00:00
|
|
|
{
|
2022-12-15 01:04:16 +00:00
|
|
|
return $this->belongsTo(Egg::class);
|
2017-03-12 23:34:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return server variables associated with this variable.
|
|
|
|
*/
|
2022-12-15 01:04:16 +00:00
|
|
|
public function serverVariables(): HasMany
|
2017-02-12 20:10:39 +00:00
|
|
|
{
|
2017-02-12 21:03:17 +00:00
|
|
|
return $this->hasMany(ServerVariable::class, 'variable_id');
|
2017-02-12 20:10:39 +00:00
|
|
|
}
|
2015-12-08 23:33:33 +00:00
|
|
|
}
|