nextcloud/lib/private/legacy/l10n.php

349 lines
9.5 KiB
PHP
Raw Normal View History

2011-06-19 16:27:52 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Andreas Ergenzinger <andreas.ergenzinger@gmx.de>
* @author Andreas Fischer <bantu@owncloud.com>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Jakob Sack <mail@jakobsack.de>
* @author Jan-Christoph Borchardt <hey@jancborchardt.net>
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lennart Rosam <lennart.rosam@medien-systempartner.de>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2015-03-26 13:44:34 +03:00
* @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Thomas Tanghus <thomas@tanghus.net>
* @author Vincent Petry <pvince81@owncloud.com>
2011-06-19 16:27:52 +04:00
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2011-06-19 16:27:52 +04:00
*
*/
/**
* This class is for i18n and l10n
* @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->get() instead
2011-06-19 16:27:52 +04:00
*/
2013-09-25 20:34:01 +04:00
class OC_L10N implements \OCP\IL10N {
2011-06-19 16:27:52 +04:00
/**
* cache
*/
protected static $cache = array();
protected static $availableLanguages = array();
2012-08-29 10:38:33 +04:00
2011-06-19 16:27:52 +04:00
/**
* The best language
*/
protected static $language = '';
2012-08-29 10:38:33 +04:00
/**
* App of this object
*/
protected $app;
/**
* Language of this object
*/
protected $lang;
2011-06-19 16:27:52 +04:00
/**
* Translations
*/
private $translations = array();
2012-08-29 10:38:33 +04:00
/**
2013-08-01 23:18:18 +04:00
* Plural forms (string)
*/
private $pluralFormString = 'nplurals=2; plural=(n != 1);';
2013-08-01 23:18:18 +04:00
/**
* Plural forms (function)
*/
private $pluralFormFunction = null;
2011-06-19 16:27:52 +04:00
/**
* The constructor
* @param string $app app requesting l10n
* @param string $lang default: null Language
2011-06-19 16:27:52 +04:00
*
* If language is not set, the constructor tries to find the right
* language.
* @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->get() instead
2011-06-19 16:27:52 +04:00
*/
2012-09-07 17:22:01 +04:00
public function __construct($app, $lang = null) {
$app = \OC_App::cleanAppId($app);
$this->app = $app;
if ($lang !== null) {
$lang = str_replace(array('\0', '/', '\\', '..'), '', $lang);
}
// Find the right language
2016-01-15 16:59:48 +03:00
if ($app !== 'test' && !\OC::$server->getL10NFactory()->languageExists($app, $lang)) {
$lang = \OC::$server->getL10NFactory()->findLanguage($app);
}
$this->lang = $lang;
2012-06-07 19:25:25 +04:00
}
2012-08-29 10:38:33 +04:00
/**
* @param $transFile
* @return bool
*/
public function load($transFile) {
$this->app = true;
$json = json_decode(file_get_contents($transFile), true);
if (!is_array($json)) {
$jsonError = json_last_error();
\OC::$server->getLogger()->warning("Failed to load $transFile - json error code: $jsonError", ['app' => 'l10n']);
return false;
}
$this->pluralFormString = $json['pluralForm'];
$translations = $json['translations'];
$this->translations = array_merge($this->translations, $translations);
return true;
}
2012-09-07 17:22:01 +04:00
protected function init() {
if ($this->app === true) {
return;
}
$app = $this->app;
$lang = $this->lang;
$this->app = true;
2011-06-19 16:27:52 +04:00
/** @var \OC\L10N\Factory $factory */
$factory = \OC::$server->getL10NFactory();
$languageFiles = $factory->getL10nFilesForApp($app, $lang);
2013-08-01 23:18:18 +04:00
$this->translations = [];
foreach ($languageFiles as $languageFile) {
$this->load($languageFile);
2013-08-01 23:18:18 +04:00
}
}
2013-01-14 23:30:28 +04:00
/**
* Translating
* @param string $text The text we need a translation for
2013-01-14 23:30:28 +04:00
* @param array $parameters default:array() Parameters for sprintf
* @return \OC_L10N_String Translation or the same text
*
* Returns the translation. If no translation is found, $text will be
* returned.
*/
2012-09-07 17:22:01 +04:00
public function t($text, $parameters = array()) {
return new OC_L10N_String($this, $text, $parameters);
2011-06-19 16:27:52 +04:00
}
/**
* Translating
* @param string $text_singular the string to translate for exactly one object
* @param string $text_plural the string to translate for n objects
* @param integer $count Number of objects
* @param array $parameters default:array() Parameters for sprintf
* @return \OC_L10N_String Translation or the same text
*
* Returns the translation. If no translation is found, $text will be
* returned. %n will be replaced with the number of objects.
*
* The correct plural is determined by the plural_forms-function
* provided by the po file.
*
*/
public function n($text_singular, $text_plural, $count, $parameters = array()) {
$this->init();
2013-12-07 14:38:01 +04:00
$identifier = "_${text_singular}_::_${text_plural}_";
if( array_key_exists($identifier, $this->translations)) {
return new OC_L10N_String( $this, $identifier, $parameters, $count );
2014-04-21 17:44:54 +04:00
}else{
if($count === 1) {
return new OC_L10N_String($this, $text_singular, $parameters, $count);
2014-04-21 17:44:54 +04:00
}else{
return new OC_L10N_String($this, $text_plural, $parameters, $count);
}
}
}
2011-06-20 01:33:34 +04:00
/**
* getTranslations
2014-05-11 21:05:28 +04:00
* @return array Fetch all translations
2011-06-20 01:33:34 +04:00
*
* Returns an associative array with all translations
*/
2012-09-07 17:22:01 +04:00
public function getTranslations() {
$this->init();
2011-06-20 01:33:34 +04:00
return $this->translations;
}
2013-08-01 23:18:18 +04:00
/**
* getPluralFormFunction
2014-05-11 21:05:28 +04:00
* @return string the plural form function
2013-08-01 23:18:18 +04:00
*
* returned function accepts the argument $n
*/
2013-08-01 23:36:33 +04:00
public function getPluralFormFunction() {
2013-08-01 23:18:18 +04:00
$this->init();
if (is_null($this->pluralFormFunction)) {
$this->pluralFormFunction = \OC::$server->getL10NFactory()->createPluralFunction($this->pluralFormString);
2013-08-01 23:18:18 +04:00
}
return $this->pluralFormFunction;
}
2011-06-19 16:27:52 +04:00
/**
* Localization
* @param string $type Type of localization
2014-05-04 15:01:57 +04:00
* @param array|int|string $data parameters for this localization
* @param array $options
* @return string|false
2011-06-19 16:27:52 +04:00
*
* Returns the localized data.
2012-08-29 10:38:33 +04:00
*
2011-06-19 16:27:52 +04:00
* Implemented types:
* - date
* - Creates a date
2011-06-19 21:38:51 +04:00
* - params: timestamp (int/string)
2011-06-19 16:27:52 +04:00
* - datetime
* - Creates date and time
2011-06-19 21:38:51 +04:00
* - params: timestamp (int/string)
2011-06-19 16:27:52 +04:00
* - time
* - Creates a time
2011-06-19 21:38:51 +04:00
* - params: timestamp (int/string)
* - firstday: Returns the first day of the week (0 sunday - 6 saturday)
* - jsdate: Returns the short JS date format
2011-06-19 16:27:52 +04:00
*/
2014-10-13 19:44:57 +04:00
public function l($type, $data, $options = array()) {
if ($type === 'firstday') {
return $this->getFirstWeekDay();
}
if ($type === 'jsdate') {
return $this->getDateFormat();
}
$this->init();
2014-10-13 19:44:57 +04:00
$value = new DateTime();
if($data instanceof DateTime) {
$value = $data;
} elseif(is_string($data) && !is_numeric($data)) {
$data = strtotime($data);
$value->setTimestamp($data);
} else {
$value->setTimestamp($data);
}
// Use the language of the instance
$locale = $this->transformToCLDRLocale($this->getLanguageCode());
2014-10-13 19:44:57 +04:00
$options = array_merge(array('width' => 'long'), $options);
$width = $options['width'];
2012-09-07 17:22:01 +04:00
switch($type) {
2011-06-19 16:27:52 +04:00
case 'date':
2014-10-13 19:44:57 +04:00
return Punic\Calendar::formatDate($value, $width, $locale);
2011-06-19 16:27:52 +04:00
case 'datetime':
2014-10-13 19:44:57 +04:00
return Punic\Calendar::formatDatetime($value, $width, $locale);
2011-06-19 16:27:52 +04:00
case 'time':
2014-10-13 19:44:57 +04:00
return Punic\Calendar::formatTime($value, $width, $locale);
2011-06-19 16:27:52 +04:00
default:
return false;
}
}
/**
* The code (en, de, ...) of the language that is used for this OC_L10N object
*
* @return string language
*/
public function getLanguageCode() {
return $this->lang;
}
2014-10-13 19:44:57 +04:00
/**
* @return string
* @throws \Punic\Exception\ValueNotInList
* @deprecated 9.0.0 Use $this->l('jsdate', null) instead
2014-10-13 19:44:57 +04:00
*/
public function getDateFormat() {
$locale = $this->transformToCLDRLocale($this->getLanguageCode());
2014-10-13 19:44:57 +04:00
return Punic\Calendar::getDateFormat('short', $locale);
}
/**
* @return int
* @deprecated 9.0.0 Use $this->l('firstday', null) instead
2014-10-13 19:44:57 +04:00
*/
public function getFirstWeekDay() {
$locale = $this->transformToCLDRLocale($this->getLanguageCode());
2014-10-13 19:44:57 +04:00
return Punic\Calendar::getFirstWeekday($locale);
}
/**
* @param string $locale
* @return string
*/
private function transformToCLDRLocale($locale) {
if ($locale === 'sr@latin') {
return 'sr_latn';
}
return $locale;
}
/**
* find the best language
* @param string $app
* @return string language
*
* If nothing works it returns 'en'
* @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findLanguage() instead
*/
public static function findLanguage($app = null) {
return \OC::$server->getL10NFactory()->findLanguage($app);
}
/**
* @return string
* @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->setLanguageFromRequest() instead
*/
public static function setLanguageFromRequest() {
return \OC::$server->getL10NFactory()->setLanguageFromRequest();
}
/**
* find all available languages for an app
* @param string $app App that needs to be translated
* @return array an array of available languages
* @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->findAvailableLanguages() instead
*/
public static function findAvailableLanguages($app=null) {
return \OC::$server->getL10NFactory()->findAvailableLanguages($app);
}
/**
* @param string $app
* @param string $lang
* @return bool
* @deprecated 9.0.0 Use \OC::$server->getL10NFactory()->languageExists() instead
*/
public static function languageExists($app, $lang) {
return \OC::$server->getL10NFactory()->languageExists($app, $lang);
}
}