<?php
namespace App\KommaApp\Kms\Core;
use App\KommaApp\Routes\RouteModelInterface;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Database\Eloquent\Relations\MorphOne;
use Illuminate\Database\Query\Builder;

/**
 * Indicates that an eloquent model has a routes method wich resolves to RoutableInterfaces
 *
 * Interface HasRoutesInterface
 * @package App\KommaApp\Kms\Core
 */
interface HasRoutesInterface
{
    /**
     * @return MorphOne returns a MorphOne relation that resolves to RouteModelInterface
     * @see RouteModelInterface
     */
    public function route():MorphOne;

    /**
     * @return MorphMany returns a MorphMany relation that resolves to RedirectRouteModelInterface
     * @see RedirectRouteModelInterface
     */
    public function redirectRoutes(): MorphMany;

    /**
     * Returns the query builder to return all routes
     *
     * @return Builder|static
     */
    public function routes(): Builder;
}