<?php
namespace App\MethodSteps\Models;

use App\Users\Models\SiteUser;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Support\Carbon;
use Illuminate\Support\Str;
use Komma\KMS\Core\AbstractTranslatableModel;
use Komma\KMS\Core\Entities\DisplayNameInterface;
use Komma\KMS\Core\Entities\DisplayNameTrait;
use Komma\KMS\Core\Tree\NestedSets\Nodes\AbstractTranslatableTreeModel;
use Komma\KMS\Core\Tree\NestedSets\Nodes\TreeModelInterface;
use Komma\KMS\Core\Tree\NestedSets\Nodes\TreeModelLogicTrait;
use Komma\KMS\Documents\DocumentsTrait;
use Komma\KMS\Documents\Kms\DocumentableInterface;
use Komma\KMS\Globalization\Languages\Models\Language;

/**
 * Class MethodStep
 *
 * @package App\MethodSteps\Models
 * @property-read \App\MethodSteps\Models\MethodStepTranslation $translation
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\MethodSteps\Models\MethodStepTranslation[] $translations
 * @property int $id
 * @property int $active
 * @property \Carbon\Carbon|null $created_at
 * @property \Carbon\Carbon|null $updated_at
 * @method static \Illuminate\Database\Eloquent\Builder|\App\MethodSteps\Models\MethodStep whereActive($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\MethodSteps\Models\MethodStep whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\MethodSteps\Models\MethodStep whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\MethodSteps\Models\MethodStep whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder|\App\MethodSteps\Models\MethodStep newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\MethodSteps\Models\MethodStep newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder|\App\MethodSteps\Models\MethodStep query()
 */
final class MethodStep extends AbstractTranslatableTreeModel implements DisplayNameInterface, TreeModelInterface
{
    use DisplayNameTrait;
    use TreeModelLogicTrait;

    protected $class = MethodStep::class;

    protected $protected = ['id', 'created_at', 'updated_at', 'site_id'];

    /**
     * Gets the translation models for this model
     *
     * @return HasMany that resolves to AbstractTranslationModel instances
     */
    public function translations(): HasMany
    {
        return $this->hasMany(MethodStepTranslation::class);
    }

    public function languages(): BelongsToMany
    {
        return $this->belongsToMany(Language::class, 'post_translations')
            ->withPivot('name', 'description')
            ->withTimestamps();
    }
}