Arcanedev\LaravelLang\Contracts\TransManager

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	getPaths()	0	1	?
	getCollection()	0	1	?
	getFrom()	0	1	?
	keys()	0	1	?
	count()	0	1	?
	hasCollection()	0	1	?

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelLang\Contracts;

use Arcanedev\LaravelLang\Entities\{Locale, LocaleCollection};

/**
 * Interface  TransManager
 *
 * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
 */
interface TransManager
{
    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the translation paths.
     *
     * @return array
     */
    public function getPaths(): array;

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get locale collection by group location.
     *
     * @param  string      $group
     * @param  mixed|null  $default
     *
     * @return \Arcanedev\LaravelLang\Entities\LocaleCollection|null
     */
    public function getCollection(string $group, $default = null): ?LocaleCollection;

    /**
     * Get a locale translations from a group.
     *
     * @param  string      $group
     * @param  string      $locale
     * @param  mixed|null  $default
     *
     * @return \Arcanedev\LaravelLang\Entities\Locale|null
     */
    public function getFrom(string $group, string $locale, $default = null): ?Locale;

    /**
     * Get locale keys.
     *
     * @return array
     */
    public function keys(): array;

    /**
     * Get locales count.
     *
     * @return int
     */
    public function count(): int;

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if a translation group exists.
     *
     * @param  string  $group
     *
     * @return bool
     */
    public function hasCollection(string $group): bool;
}