eveseat/eveapi

<?php

/*
 * This file is part of SeAT
 *
 * Copyright (C) 2015 to present Leon Jacobs
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

namespace Seat\Eveapi\Models\Skills;

use OpenApi\Attributes as OA;
use Seat\Eveapi\Models\Sde\InvType;
use Seat\Services\Contracts\HasTypeID;
use Seat\Services\Models\ExtensibleModel;

#[OA\Schema(
    title: 'CharacterSkillQueue',
    description: 'Character Skill Queue',
    properties: [
        new OA\Property(property: 'finish_date', description: 'The date/time when the skill training will end', type: 'string', format: 'date-time'),
        new OA\Property(property: 'finished_level', description: 'The level at which the skill will be at end of the training', type: 'integer'),
        new OA\Property(property: 'queue_position', description: 'The position in the queue', type: 'integer'),
        new OA\Property(property: 'training_start_sp', description: 'The skillpoint amount in the skill when training start', type: 'integer'),
        new OA\Property(property: 'level_end_sp', description: 'The skillpoint amount earned at end of the level training', type: 'integer'),
        new OA\Property(property: 'level_start_sp', description: 'The skillpoint amount from which the training level is starting', type: 'integer'),
        new OA\Property(property: 'type', ref: '#/components/schemas/InvType'),
    ],
    type: 'object'
)]
class CharacterSkillQueue extends ExtensibleModel implements HasTypeID
{
    /**
     * @var array
     */
    protected $hidden = ['id', 'character_id', 'skill_id', 'created_at', 'updated_at'];

    /**
     * @var string[]
     */
    protected $casts = [
        'start_date' => 'datetime',
        'finish_date' => 'datetime',
    ];

    /**
     * @var bool
     */
    protected static $unguarded = true;

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function type()
    {

        return $this->belongsTo(InvType::class, 'skill_id', 'typeID');
    }

    /**
     * @return int The eve type id of this object
     */
    public function getTypeID(): int
    {
        return $this->type_id;
    }
}