<?php

namespace App\KommaApp\Kms\Core;

use App\KommaApp\Sites\Models\Site;
use Illuminate\Support\Collection;

interface KmsInterface
{

    /**
     * @return \Illuminate\Database\Eloquent\Collection|static[]
     */
    public function getSites(): Collection;

    /**
     * @param $siteSlug
     */
    public function setSite(string $siteSlug);

    /**
     * @return Site
     */
    public function getSite();

    /**
     * @return int
     */
    public function getSiteId();

    /**
     * @return int
     */
    public function getSiteDefaultLanguage(): int;

    /**
     * @return string
     */
    public function getSiteSlug();

    /**
     * @return Collection
     */
    public function getSiteLanguages(): Collection;

    /**
     * Gets a class name (with or without namespace) and returns the class name only without the namespace
     *
     * @param object|string $classInstanceOrReference
     * @param bool $snakecase If true then the shortModelClassName will be formatted to snake_case.
     * @param bool $removeModelString Wether or not to remove the string 'model' if it is in the class name
     * @return string
     */
    public function getShortNameFromClass($classInstanceOrReference, bool $snakecase = false, bool $removeModelString = false): string;
}