TranslatorServiceInterface.php

<?php
declare(strict_types=1);

/**
 * Pimcore
 *
 * This source file is available under two different licenses:
 * - GNU General Public License version 3 (GPLv3)
 * - Pimcore Commercial License (PCL)
 * Full copyright and license information is available in
 * LICENSE.md which is distributed with this source code.
 *
 *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
 *  @license    http://www.pimcore.org/license     GPLv3 and PCL
 */

namespace Pimcore\Bundle\StudioBackendBundle\Translation\Service;

use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidLocaleException;
use Pimcore\Bundle\StudioBackendBundle\Translation\Schema\CreateTranslation;
use Pimcore\Bundle\StudioBackendBundle\Translation\Schema\Translation;
use Pimcore\Bundle\StudioBackendBundle\Translation\Schema\UpdateTranslation;

/**
 * @internal
 */
interface TranslatorServiceInterface
{
    public const string DOMAIN = 'studio';

    public function createTranslations(CreateTranslation $translation): void;

    /**
     * @throws InvalidLocaleException
     */
    public function updateTranslations(UpdateTranslation $translation): void;

    /**
     * @throws InvalidLocaleException
     */
    public function getAllTranslations(string $locale): Translation;

    /**
     * @throws InvalidLocaleException
     */
    public function getTranslationsForKeys(string $locale, array $keys): Translation;

    public function deleteTranslationByKey(string $key): void;

    public function translate(string $message, array $params = []): string;

    public function translateApiDocs(string $message, string $locale = 'en'): string;
}