Commit 71ebe230 authored by alexpott's avatar alexpott
Browse files

Issue #2453761 by Gábor Hojtsy: Views numeric formatter's plural formatting...

Issue #2453761 by Gábor Hojtsy: Views numeric formatter's plural formatting setting incompatible with many languages
parent 5ff53d74
......@@ -603,7 +603,7 @@ services:
- { name: string_translator, priority: 30 }
string_translation:
class: Drupal\Core\StringTranslation\TranslationManager
arguments: ['@language_manager']
arguments: ['@language_manager', '@state']
calls:
- [initLanguageManager]
tags:
......
......@@ -63,6 +63,17 @@ protected function formatPluralTranslated($count, $translated, array $args = arr
return $this->getStringTranslation()->formatPluralTranslated($count, $translated, $args, $options);
}
/**
* Returns the number of plurals supported by a given language.
*
* See the
* \Drupal\Core\StringTranslation\TranslationInterface::getNumberOfPlurals()
* documentation for details.
*/
protected function getNumberOfPlurals($langcode = NULL) {
return $this->getStringTranslation()->getNumberOfPlurals($langcode);
}
/**
* Gets the string translation service.
*
......
......@@ -120,4 +120,16 @@ public function formatPlural($count, $singular, $plural, array $args = array(),
*/
public function formatPluralTranslated($count, $translation, array $args = array(), array $options = array());
/**
* Returns the number of plurals supported by a given language.
*
* @param null|string $langcode
* (optional) The language code. If not provided, the current language
* will be used.
*
* @return int
* Number of plural variants supported by the given language.
*/
public function getNumberOfPlurals($langcode = NULL);
}
......@@ -9,6 +9,7 @@
use Drupal\Component\Utility\SafeMarkup;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\State\StateInterface;
use Drupal\Core\StringTranslation\Translator\TranslatorInterface;
/**
......@@ -52,15 +53,25 @@ class TranslationManager implements TranslationInterface, TranslatorInterface {
*/
protected $defaultLangcode;
/**
* The state service.
*
* @var \Drupal\Core\State\StateInterface
*/
protected $state;
/**
* Constructs a TranslationManager object.
*
* @param \Drupal\Core\Language\LanguageManagerInterface
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\State\StateInterface $state
* (optional) The state service.
*/
public function __construct(LanguageManagerInterface $language_manager) {
public function __construct(LanguageManagerInterface $language_manager, StateInterface $state = NULL) {
$this->languageManager = $language_manager;
$this->defaultLangcode = $language_manager->getDefaultLanguage()->getId();
$this->state = $state;
}
/**
......@@ -229,4 +240,21 @@ public function reset() {
}
}
/**
* @inheritdoc.
*/
public function getNumberOfPlurals($langcode = NULL) {
// If the state service is not injected, we assume 2 plural variants are
// allowed. This may happen in the installer for simplicity. We also assume
// 2 plurals if there is no explicit information yet.
if (isset($this->state)) {
$langcode = $langcode ?: $this->languageManager->getCurrentLanguage()->getId();
$plural_formulas = $this->state->get('locale.translation.plurals') ?: array();
if (isset($plural_formulas[$langcode]['plurals'])) {
return $plural_formulas[$langcode]['plurals'];
}
}
return 2;
}
}
......@@ -91,6 +91,7 @@ public function getTranslationBuild(LanguageInterface $source_language, Language
* A render array for the source value.
*/
protected function getSourceElement(LanguageInterface $source_language, $source_config) {
// @todo Should support singular+plurals https://www.drupal.org/node/2454829
if ($source_config) {
$value = '<span lang="' . $source_language->getId() . '">' . nl2br($source_config) . '</span>';
}
......@@ -161,6 +162,7 @@ protected function getSourceElement(LanguageInterface $source_language, $source_
*/
protected function getTranslationElement(LanguageInterface $translation_language, $source_config, $translation_config) {
// Add basic properties that apply to all form elements.
// @todo Should support singular+plurals https://www.drupal.org/node/2454829
return array(
'#title' => $this->t('!label <span class="visually-hidden">(!source_language)</span>', array(
'!label' => $this->t($this->definition['label']),
......
......@@ -529,8 +529,7 @@ display:
decimal: .
separator: ','
format_plural: true
format_plural_singular: '1 place'
format_plural_plural: '@count places'
format_plural_string: "1 place\x03@count places"
prefix: ''
suffix: ''
plugin_id: numeric
......@@ -952,8 +951,7 @@ display:
decimal: .
separator: ','
format_plural: false
format_plural_singular: '1'
format_plural_plural: '@count'
format_plural_string: "1\x03@count"
prefix: ''
suffix: ''
plugin_id: numeric
......
......@@ -141,8 +141,7 @@ display:
decimal: .
separator: ','
format_plural: false
format_plural_singular: '1'
format_plural_plural: '@count'
format_plural_string: "1\x03@count"
prefix: ''
suffix: ''
plugin_id: numeric
......
......@@ -58,7 +58,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
if (isset($langcode)) {
$strings = $this->translateFilterLoadStrings();
$plural_formulas = $this->state->get('locale.translation.plurals') ?: array();
$plurals = $this->getNumberOfPlurals($langcode);
foreach ($strings as $string) {
// Cast into source string, will do for our purposes.
......@@ -119,38 +119,21 @@ public function buildForm(array $form, FormStateInterface $form_state) {
);
}
else {
// Dealing with plural strings.
if (isset($plural_formulas[$langcode]['plurals']) && $plural_formulas[$langcode]['plurals'] > 2) {
// Add a textarea for each plural variant.
for ($i = 0; $i < $plural_formulas[$langcode]['plurals']; $i++) {
$form['strings'][$string->lid]['translations'][$i] = array(
'#type' => 'textarea',
'#title' => ($i == 0 ? $this->t('Singular form') : $this->formatPlural($i, 'First plural form', '@count. plural form')),
'#rows' => $rows,
'#default_value' => isset($translation_array[$i]) ? $translation_array[$i] : '',
'#attributes' => array('lang' => $langcode),
'#prefix' => $i == 0 ? ('<span class="visually-hidden">' . $this->t('Translated string (@language)', array('@language' => $langname)) . '</span>') : '',
);
}
}
else {
// Fallback for unknown number of plurals.
$form['strings'][$string->lid]['translations'][0] = array(
'#type' => 'textarea',
'#title' => $this->t('Singular form'),
'#rows' => $rows,
'#default_value' => $translation_array[0],
'#attributes' => array('lang' => $langcode),
'#prefix' => '<span class="visually-hidden">' . $this->t('Translated string (@language)', array('@language' => $langname)) . '</span>',
);
$form['strings'][$string->lid]['translations'][1] = array(
// Add a textarea for each plural variant.
for ($i = 0; $i < $plurals; $i++) {
$form['strings'][$string->lid]['translations'][$i] = array(
'#type' => 'textarea',
'#title' => $this->t('Plural form'),
'#title' => ($i == 0 ? $this->t('Singular form') : $this->formatPlural($i, 'First plural form', '@count. plural form')),
'#rows' => $rows,
'#default_value' => isset($translation_array[1]) ? $translation_array[1] : '',
'#default_value' => isset($translation_array[$i]) ? $translation_array[$i] : '',
'#attributes' => array('lang' => $langcode),
'#prefix' => $i == 0 ? ('<span class="visually-hidden">' . $this->t('Translated string (@language)', array('@language' => $langname)) . '</span>') : '',
);
}
if ($plurals == 2) {
// Simplify user interface text for the most common case.
$form['strings'][$string->lid]['translations'][1]['#title'] = $this->t('Plural form');
}
}
}
if (count(Element::children($form['strings']))) {
......
......@@ -160,8 +160,7 @@ display:
decimal: .
separator: ''
format_plural: false
format_plural_singular: '1'
format_plural_plural: '@count'
format_plural_string: "1\x03@count"
prefix: ''
suffix: ''
plugin_id: numeric
......@@ -218,8 +217,7 @@ display:
decimal: .
separator: ''
format_plural: false
format_plural_singular: '1'
format_plural_plural: '@count'
format_plural_string: "1\x03@count"
prefix: ''
suffix: ''
plugin_id: numeric
......
......@@ -116,12 +116,9 @@ views.field.numeric:
format_plural:
type: boolean
label: 'Format plural'
format_plural_singular:
format_plural_string:
type: label
label: 'Singular form'
format_plural_plural:
type: label
label: 'Plural form'
label: 'Singular and one or more plurals'
prefix:
type: label
label: 'Prefix'
......
......@@ -34,8 +34,7 @@ protected function defineOptions() {
$options['decimal'] = array('default' => '.');
$options['separator'] = array('default' => ',');
$options['format_plural'] = array('default' => FALSE);
$options['format_plural_singular'] = array('default' => '1');
$options['format_plural_plural'] = array('default' => '@count');
$options['format_plural_string'] = array('default' => '1' . LOCALE_PLURAL_DELIMITER . '@count');
$options['prefix'] = array('default' => '');
$options['suffix'] = array('default' => '');
......@@ -93,28 +92,33 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) {
'#description' => $this->t('If checked, special handling will be used for plurality.'),
'#default_value' => $this->options['format_plural'],
);
$form['format_plural_singular'] = array(
'#type' => 'textfield',
'#title' => $this->t('Singular form'),
'#default_value' => $this->options['format_plural_singular'],
'#description' => $this->t('Text to use for the singular form.'),
'#states' => array(
'visible' => array(
':input[name="options[format_plural]"]' => array('checked' => TRUE),
),
),
$form['format_plural_string'] = array(
'#type' => 'value',
'#default_value' => $this->options['format_plural_string'],
);
$form['format_plural_plural'] = array(
'#type' => 'textfield',
'#title' => $this->t('Plural form'),
'#default_value' => $this->options['format_plural_plural'],
'#description' => $this->t('Text to use for the plural form, @count will be replaced with the value.'),
'#states' => array(
'visible' => array(
':input[name="options[format_plural]"]' => array('checked' => TRUE),
$plural_array = explode(LOCALE_PLURAL_DELIMITER, $this->options['format_plural_string']);
$plurals = $this->getNumberOfPlurals($this->view->storage->get('langcode'));
for ($i = 0; $i < $plurals; $i++) {
$form['format_plural_values'][$i] = array(
'#type' => 'textfield',
'#title' => ($i == 0 ? $this->t('Singular form') : $this->formatPlural($i, 'First plural form', '@count. plural form')),
'#default_value' => isset($plural_array[$i]) ? $plural_array[$i] : '',
'#description' => $this->t('Text to use for this variant, @count will be replaced with the value.'),
'#states' => array(
'visible' => array(
':input[name="options[format_plural]"]' => array('checked' => TRUE),
),
),
),
);
);
}
if ($plurals == 2) {
// Simplify user interface text for the most common case.
$form['format_plural_values'][0]['#description'] = $this->t('Text to use for the singular form, @count will be replaced with the value.');
$form['format_plural_values'][1]['#title'] = $this->t('Plural form');
$form['format_plural_values'][1]['#description'] = $this->t('Text to use for the plural form, @count will be replaced with the value.');
}
$form['prefix'] = array(
'#type' => 'textfield',
'#title' => $this->t('Prefix'),
......@@ -131,6 +135,18 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
}
/**
* @inheritdoc
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
// Merge plural format options into one string and drop the individual
// option values.
$options = &$form_state->getValue('options');
$options['format_plural_string'] = implode(LOCALE_PLURAL_DELIMITER, $options['format_plural_values']);
unset($options['format_plural_values']);
parent::submitOptionsForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
......@@ -154,9 +170,10 @@ public function render(ResultRow $values) {
return '';
}
// Should we format as a plural.
// If we should format as plural, take the (possibly) translated plural
// setting and format with the current language.
if (!empty($this->options['format_plural'])) {
$value = $this->formatPlural($value, $this->options['format_plural_singular'], $this->options['format_plural_plural']);
$value = $this->formatPluralTranslated($value, $this->options['format_plural_string']);
}
return $this->sanitizeValue($this->options['prefix'], 'xss')
......
<?php
/**
* @file
* Contains \Drupal\views\Tests\Plugin\NumericFormatPluralTest.
*/
namespace Drupal\views\Tests\Plugin;
use Drupal\Component\Gettext\PoHeader;
use Drupal\views\Tests\ViewTestBase;
/**
* Tests the creation of numeric fields.
*
* @group field
*/
class NumericFormatPluralTest extends ViewTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array('views_ui', 'file', 'language', 'locale');
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = array('numeric_test');
/**
* A user with permission to view and manage views and languages.
*
* @var \Drupal\user\UserInterface
*/
protected $web_user;
protected function setUp() {
parent::setUp();
$this->web_user = $this->drupalCreateUser(array('administer views', 'administer languages'));
$this->drupalLogin($this->web_user);
}
/**
* Test plural formatting setting on a numeric views handler.
*/
function testNumericFormatPlural() {
// Create a file.
$file = $this->createFile();
// Assert that the starting configuration is correct.
$config = $this->config('views.view.numeric_test');
$field_config_prefix = 'display.default.display_options.fields.count.';
$this->assertEqual($config->get($field_config_prefix . 'format_plural'), TRUE);
$this->assertEqual($config->get($field_config_prefix . 'format_plural_string'), '1' . LOCALE_PLURAL_DELIMITER . '@count');
// Assert that the value is displayed.
$this->drupalGet('numeric-test');
$this->assertRaw('<span class="field-content">0</span>');
// Assert that the user interface has controls to change it.
$this->drupalGet('admin/structure/views/nojs/handler/numeric_test/page_1/field/count');
$this->assertFieldByName('options[format_plural_values][0]', '1');
$this->assertFieldByName('options[format_plural_values][1]', '@count');
// Assert that changing the settings will change configuration properly.
$edit = ['options[format_plural_values][0]' => '1 time', 'options[format_plural_values][1]' => '@count times'];
$this->drupalPostForm(NULL, $edit, t('Apply'));
$this->drupalPostForm(NULL, array(), t('Save'));
$config = $this->config('views.view.numeric_test');
$field_config_prefix = 'display.default.display_options.fields.count.';
$this->assertEqual($config->get($field_config_prefix . 'format_plural'), TRUE);
$this->assertEqual($config->get($field_config_prefix . 'format_plural_string'), '1 time' . LOCALE_PLURAL_DELIMITER . '@count times');
// Assert that the value is displayed with some sample values.
$numbers = [0, 1, 2, 3, 4, 42];
foreach ($numbers as $i => $number) {
\Drupal::service('file.usage')->add($file, 'views_ui', 'dummy', $i, $number);
}
$this->drupalGet('numeric-test');
foreach ($numbers as $i => $number) {
$this->assertRaw('<span class="field-content">' . $number . ($number == 1 ? ' time' : ' times') . '</span>');
}
// Add Slovenian and set its plural formula to test multiple plural forms.
$edit = ['predefined_langcode' => 'sl'];
$this->drupalPostForm('admin/config/regional/language/add', $edit, t('Add language'));
$formula = 'nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n%100==4 ? 2 : 3);';
$header = new PoHeader();
list($nplurals, $formula) = $header->parsePluralForms($formula);
\Drupal::state()->set('locale.translation.plurals', ['sl' => ['plurals' => $nplurals, 'formula' => $formula]]);
// Change the view to Slovenian.
$config = $this->config('views.view.numeric_test');
$config->set('langcode', 'sl')->save();
// Assert that the user interface has controls with more inputs now.
$this->drupalGet('admin/structure/views/nojs/handler/numeric_test/page_1/field/count');
$this->assertFieldByName('options[format_plural_values][0]', '1 time');
$this->assertFieldByName('options[format_plural_values][1]', '@count times');
$this->assertFieldByName('options[format_plural_values][2]', '');
$this->assertFieldByName('options[format_plural_values][3]', '');
// Assert that changing the settings will change configuration properly.
$edit = [
'options[format_plural_values][0]' => '@count time0',
'options[format_plural_values][1]' => '@count time1',
'options[format_plural_values][2]' => '@count time2',
'options[format_plural_values][3]' => '@count time3',
];
$this->drupalPostForm(NULL, $edit, t('Apply'));
$this->drupalPostForm(NULL, array(), t('Save'));
$config = $this->config('views.view.numeric_test');
$field_config_prefix = 'display.default.display_options.fields.count.';
$this->assertEqual($config->get($field_config_prefix . 'format_plural'), TRUE);
$this->assertEqual($config->get($field_config_prefix . 'format_plural_string'), implode(LOCALE_PLURAL_DELIMITER, array_values($edit)));
// The view should now use the new plural configuration.
$this->drupalGet('sl/numeric-test');
$this->assertRaw('<span class="field-content">0 time3</span>');
$this->assertRaw('<span class="field-content">1 time0</span>');
$this->assertRaw('<span class="field-content">2 time1</span>');
$this->assertRaw('<span class="field-content">3 time2</span>');
$this->assertRaw('<span class="field-content">4 time2</span>');
$this->assertRaw('<span class="field-content">42 time3</span>');
// Add an English configuration translation with English plurals.
$english = \Drupal::languageManager()->getLanguageConfigOverride('en', 'views.view.numeric_test');
$english->set('display.default.display_options.fields.count.format_plural_string', '1 time' . LOCALE_PLURAL_DELIMITER . '@count times')->save();
// The view displayed in English should use the English translation.
$this->drupalGet('numeric-test');
$this->assertRaw('<span class="field-content">0 times</span>');
$this->assertRaw('<span class="field-content">1 time</span>');
$this->assertRaw('<span class="field-content">2 times</span>');
$this->assertRaw('<span class="field-content">3 times</span>');
$this->assertRaw('<span class="field-content">4 times</span>');
$this->assertRaw('<span class="field-content">42 times</span>');
}
/**
* Creates and saves a test file.
*
* @return \Drupal\Core\Entity\EntityInterface
* A file entity.
*/
protected function createFile() {
// Create a new file entity.
$file = entity_create('file', array(
'uid' => 1,
'filename' => 'druplicon.txt',
'uri' => 'public://druplicon.txt',
'filemime' => 'text/plain',
'created' => 1,
'changed' => 1,
'status' => FILE_STATUS_PERMANENT,
));
file_put_contents($file->getFileUri(), 'hello world');
// Save it, inserting a new record.
$file->save();
return $file;
}
}
uuid: 6f602122-2918-44c7-8b05-5d6c1e93e6ac
langcode: en
status: true
dependencies:
module:
- file
- user
id: numeric_test
label: 'Numeric test'
module: views
description: ''
tag: ''
base_table: file_managed
base_field: fid
core: 8.x
display:
default:
display_plugin: default
id: default
display_title: Master
position: 0
display_options:
access:
type: perm
options:
perm: 'administer views'
cache:
type: none
options: { }
query:
type: views_query
options:
disable_sql_rewrite: false
distinct: false
replica: false
query_comment: ''
query_tags: { }
exposed_form:
type: basic
options:
submit_button: Apply
reset_button: false
reset_button_label: Reset
exposed_sorts_label: 'Sort by'
expose_sort_order: true
sort_asc_label: Asc
sort_desc_label: Desc
pager:
type: full
options:
items_per_page: 10
offset: 0
id: 0
total_pages: null
expose:
items_per_page: false
items_per_page_label: 'Items per page'
items_per_page_options: '5, 10, 25, 50'
items_per_page_options_all: false
items_per_page_options_all_label: '- All -'
offset: false
offset_label: Offset
tags:
previous: ' previous'
next: 'next ›'
first: '« first'
last: 'last »'
quantity: 9