Arcanedev\LaravelLang\Contracts\TransPublisher

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	publish()	0	1	?
	isDefault()	0	1	?
	isSupported()	0	1	?

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelLang\Contracts;

/**
 * Interface  TransPublisher
 *
 * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
 */
interface TransPublisher
{
    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Publish a lang.
     *
     * @param  string  $localeKey
     * @param  array   $options
     *
     * @return array
     *
     * @throws \Arcanedev\LaravelLang\Exceptions\LangPublishException
     */
    public function publish(string $localeKey, array $options = []): array;

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

    /**
     * Check if the locale is a default one (English is shipped with laravel).
     *
     * @param  string  $locale
     *
     * @return bool
     */
    public function isDefault(string $locale): bool;

    /**
     * Check if the locale is supported.
     *
     * @param  string  $key
     *
     * @return bool
     */
    public function isSupported(string $key): bool;
}