nextcloud/lib/public/Translation/ITranslationProvider.php
Julius Härtl 3e63298381
feat(translations): Add translation provider API
Signed-off-by: Julius Härtl <jus@bitgrid.net>
2023-02-27 16:52:03 +01:00

51 lines
1.3 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\Translation;
use RuntimeException;
/**
* @since 26.0.0
*/
interface ITranslationProvider {
/**
* @since 26.0.0
*/
public function getName(): string;
/**
* @since 26.0.0
*/
public function getAvailableLanguages(): array;
/**
* @since 26.0.0
* @throws RuntimeException If the text could not be translated
*/
public function translate(?string $fromLanguage, string $toLanguage, string $text): string;
}