<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Marque extends Model
{
    /**
     * The primary key associated with the table.
     *
     * @var string
     */
    protected $primaryKey = 'codMarq';

    /**
     * Indicates if the IDs are auto-incrementing.
     *
     * @var boolean
     */
    public $incrementing = false;

    // * RELATIONSHIPS

    /**
     * BelongsToMany users relation
     *
     * The users that belong to the marque.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function users()
    {
        // We have to define foreignPivotKey because primaryKey has been overwritten ...
        return $this->belongsToMany(User::class, foreignPivotKey:'marque_id');
    }

    /**
     * BelongsToMany dossiers relation
     *
     * The dossier that belong to the marque.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function dossiers()
    {
        return $this->belongsToMany(Dossier::class, 'marques_dossier', 'marque_id', 'dossier_id');
    }

    /**
     * BelongsToMany  relation
     *
     * The media that belong to the marques.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function mediaList()
    {
        return $this->belongsToMany(Media::class);
    }
}