150 lines
4.1 KiB
PHP
150 lines
4.1 KiB
PHP
<?php
|
|
|
|
namespace Pterodactyl\Models;
|
|
|
|
/**
|
|
* Pterodactyl\Models\Allocation.
|
|
*
|
|
* @property int $id
|
|
* @property int $node_id
|
|
* @property string $ip
|
|
* @property string|null $ip_alias
|
|
* @property int $port
|
|
* @property int|null $server_id
|
|
* @property string|null $notes
|
|
* @property \Carbon\Carbon|null $created_at
|
|
* @property \Carbon\Carbon|null $updated_at
|
|
* @property string $alias
|
|
* @property bool $has_alias
|
|
* @property \Pterodactyl\Models\Server|null $server
|
|
* @property \Pterodactyl\Models\Node $node
|
|
* @property string $hashid
|
|
*
|
|
* @method static \Database\Factories\AllocationFactory factory(...$parameters)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation newModelQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation newQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation query()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereCreatedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereIp($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereIpAlias($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereNodeId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereNotes($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation wherePort($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereServerId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Allocation whereUpdatedAt($value)
|
|
* @mixin \Eloquent
|
|
*/
|
|
class Allocation extends Model
|
|
{
|
|
/**
|
|
* The resource name for this model when it is transformed into an
|
|
* API representation using fractal.
|
|
*/
|
|
public const RESOURCE_NAME = 'allocation';
|
|
|
|
/**
|
|
* The table associated with the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $table = 'allocations';
|
|
|
|
/**
|
|
* Fields that are not mass assignable.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $guarded = ['id', 'created_at', 'updated_at'];
|
|
|
|
/**
|
|
* Cast values to correct type.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $casts = [
|
|
'node_id' => 'integer',
|
|
'port' => 'integer',
|
|
'server_id' => 'integer',
|
|
];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
public static $validationRules = [
|
|
'node_id' => 'required|exists:nodes,id',
|
|
'ip' => 'required|ip',
|
|
'port' => 'required|numeric|between:1024,65535',
|
|
'ip_alias' => 'nullable|string',
|
|
'server_id' => 'nullable|exists:servers,id',
|
|
'notes' => 'nullable|string|max:256',
|
|
];
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getRouteKeyName(): string
|
|
{
|
|
return $this->getKeyName();
|
|
}
|
|
|
|
/**
|
|
* Return a hashid encoded string to represent the ID of the allocation.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getHashidAttribute()
|
|
{
|
|
return app()->make('hashids')->encode($this->id);
|
|
}
|
|
|
|
/**
|
|
* Accessor to automatically provide the IP alias if defined.
|
|
*
|
|
* @param string|null $value
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getAliasAttribute($value)
|
|
{
|
|
return (is_null($this->ip_alias)) ? $this->ip : $this->ip_alias;
|
|
}
|
|
|
|
/**
|
|
* Accessor to quickly determine if this allocation has an alias.
|
|
*
|
|
* @param string|null $value
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getHasAliasAttribute($value)
|
|
{
|
|
return !is_null($this->ip_alias);
|
|
}
|
|
|
|
public function toString(): string
|
|
{
|
|
return sprintf('%s:%s', $this->ip, $this->port);
|
|
}
|
|
|
|
/**
|
|
* Gets information for the server associated with this allocation.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function server()
|
|
{
|
|
return $this->belongsTo(Server::class);
|
|
}
|
|
|
|
/**
|
|
* Return the Node model associated with this allocation.
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function node()
|
|
{
|
|
return $this->belongsTo(Node::class);
|
|
}
|
|
}
|