diff --git a/core/includes/common.inc b/core/includes/common.inc index 43c5384..667918e 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -25,6 +25,7 @@ use Drupal\Core\Render\SafeString; use Drupal\Core\Render\Renderer; use Drupal\Core\Site\Settings; +use Drupal\Core\StringTranslation\TranslationWrapper; use Drupal\Core\Url; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\Request; @@ -316,7 +317,7 @@ function check_url($uri) { * Optional language code to translate to a language other than what is used * to display the page. * - * @return + * @return \Drupal\Core\StringTranslation\TranslationWrapper * A translated string representation of the size. */ function format_size($size, $langcode = NULL) { @@ -325,16 +326,7 @@ function format_size($size, $langcode = NULL) { } else { $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes. - $units = array( - t('@size KB', array(), array('langcode' => $langcode)), - t('@size MB', array(), array('langcode' => $langcode)), - t('@size GB', array(), array('langcode' => $langcode)), - t('@size TB', array(), array('langcode' => $langcode)), - t('@size PB', array(), array('langcode' => $langcode)), - t('@size EB', array(), array('langcode' => $langcode)), - t('@size ZB', array(), array('langcode' => $langcode)), - t('@size YB', array(), array('langcode' => $langcode)), - ); + $units = ['KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']; foreach ($units as $unit) { if (round($size, 2) >= Bytes::KILOBYTE) { $size = $size / Bytes::KILOBYTE; @@ -343,7 +335,26 @@ function format_size($size, $langcode = NULL) { break; } } - return str_replace('@size', round($size, 2), $unit); + $args = ['@size' => round($size, 2)]; + $options = ['langcode' => $langcode]; + switch ($unit) { + case 'KB': + return new TranslationWrapper('@size KB', $args, $options); + case 'MB': + return new TranslationWrapper('@size MB', $args, $options); + case 'GB': + return new TranslationWrapper('@size GB', $args, $options); + case 'TB': + return new TranslationWrapper('@size TB', $args, $options); + case 'PB': + return new TranslationWrapper('@size PB', $args, $options); + case 'EB': + return new TranslationWrapper('@size EB', $args, $options); + case 'ZB': + return new TranslationWrapper('@size ZB', $args, $options); + case 'YB': + return new TranslationWrapper('@size YB', $args, $options); + } } } diff --git a/core/lib/Drupal/Component/Utility/PlaceholderTrait.php b/core/lib/Drupal/Component/Utility/PlaceholderTrait.php new file mode 100644 index 0000000..e7866a5 --- /dev/null +++ b/core/lib/Drupal/Component/Utility/PlaceholderTrait.php @@ -0,0 +1,64 @@ + $value) { + switch ($key[0]) { + case '@': + // Escaped only. + if (!SafeMarkup::isSafe($value)) { + $args[$key] = Html::escape($value); + } + break; + + case '%': + default: + // Escaped and placeholder. + if (!SafeMarkup::isSafe($value)) { + $value = Html::escape($value); + } + $args[$key] = '' . $value . ''; + break; + + case '!': + // Pass-through. + if (!SafeMarkup::isSafe($value)) { + $safe = FALSE; + } + } + } + return strtr($string, $args); + } + +} diff --git a/core/lib/Drupal/Component/Utility/SafeMarkup.php b/core/lib/Drupal/Component/Utility/SafeMarkup.php index 3020bbe..00b09f2 100644 --- a/core/lib/Drupal/Component/Utility/SafeMarkup.php +++ b/core/lib/Drupal/Component/Utility/SafeMarkup.php @@ -31,6 +31,7 @@ * @see theme_render */ class SafeMarkup { + use PlaceholderTrait; /** * The list of safe strings. @@ -204,40 +205,12 @@ public static function checkPlain($text) { */ public static function format($string, array $args) { $safe = TRUE; - - // Transform arguments before inserting them. - foreach ($args as $key => $value) { - switch ($key[0]) { - case '@': - // Escaped only. - if (!SafeMarkup::isSafe($value)) { - $args[$key] = Html::escape($value); - } - break; - - case '%': - default: - // Escaped and placeholder. - if (!SafeMarkup::isSafe($value)) { - $value = Html::escape($value); - } - $args[$key] = '' . $value . ''; - break; - - case '!': - // Pass-through. - if (!static::isSafe($value)) { - $safe = FALSE; - } - } - } - - $output = strtr($string, $args); + $output = static::placeholderFormat($string, $args, $safe); if ($safe) { static::$safeStrings[$output]['html'] = TRUE; } - return $output; + } } diff --git a/core/lib/Drupal/Core/Entity/EntityManager.php b/core/lib/Drupal/Core/Entity/EntityManager.php index dd3c8f0..9d749fb 100644 --- a/core/lib/Drupal/Core/Entity/EntityManager.php +++ b/core/lib/Drupal/Core/Entity/EntityManager.php @@ -945,9 +945,6 @@ public function getEntityTypeLabels($group = FALSE) { foreach ($definitions as $entity_type_id => $definition) { if ($group) { - // We cast the optgroup label to string as array keys must not be - // objects and t() may return a TranslationWrapper once issue #2557113 - // lands. $options[(string) $definition->getGroupLabel()][$entity_type_id] = $definition->getLabel(); } else { @@ -963,8 +960,6 @@ public function getEntityTypeLabels($group = FALSE) { // Make sure that the 'Content' group is situated at the top. $content = $this->t('Content', array(), array('context' => 'Entity type group')); - // We cast the optgroup label to string as array keys must not be objects - // and t() may return a TranslationWrapper once issue #2557113 lands. $options = array((string) $content => $options[(string) $content]) + $options; } diff --git a/core/lib/Drupal/Core/StringTranslation/TranslationInterface.php b/core/lib/Drupal/Core/StringTranslation/TranslationInterface.php index c3e2f68..d460424 100644 --- a/core/lib/Drupal/Core/StringTranslation/TranslationInterface.php +++ b/core/lib/Drupal/Core/StringTranslation/TranslationInterface.php @@ -41,6 +41,26 @@ public function translate($string, array $args = array(), array $options = array()); /** + * Translates a string to the current language or to a given language. + * + * @param string $string + * A string containing the English string to translate. + * @param array $args + * An associative array of replacements to make after translation. + * @param array $options + * An associative array of additional options, with the following elements: + * - 'langcode': The language code to translate to a language other than + * what is used to display the page. + * - 'context': The context the source string belongs to. + * + * @return string + * The translated string. + * + * @internal This method is for internal use only. Use ::translate() instead. + */ + public function translateToString($string, array $args = array(), array $options = array()); + + /** * Formats a string containing a count of items. * * This function ensures that the string is pluralized correctly. Since t() is diff --git a/core/lib/Drupal/Core/StringTranslation/TranslationManager.php b/core/lib/Drupal/Core/StringTranslation/TranslationManager.php index af6aa2b..4c9ca7e 100644 --- a/core/lib/Drupal/Core/StringTranslation/TranslationManager.php +++ b/core/lib/Drupal/Core/StringTranslation/TranslationManager.php @@ -8,6 +8,7 @@ namespace Drupal\Core\StringTranslation; use Drupal\Component\Utility\SafeMarkup; +use Drupal\Component\Utility\PlaceholderTrait; use Drupal\Core\Language\LanguageManagerInterface; use Drupal\Core\State\StateInterface; use Drupal\Core\StringTranslation\Translator\TranslatorInterface; @@ -17,6 +18,8 @@ */ class TranslationManager implements TranslationInterface, TranslatorInterface { + use PlaceholderTrait; + /** * The language manager. * @@ -140,38 +143,13 @@ public function getStringTranslation($langcode, $string, $context) { * {@inheritdoc} */ public function translate($string, array $args = array(), array $options = array()) { - $string = $this->doTranslate($string, $options); - if (empty($args)) { - // We add the string to the safe list as opposed to making it an object - // implementing SafeStringInterface as we may need to call __toString() - // on the object before render time, at which point the string ceases to - // be safe, and working around this would require significant rework. - // Adding this string to the safe list is assumed to be safe because - // translate() should only be called with strings defined in code. - // @see \Drupal\Core\StringTranslation\TranslationInterface::translate() - SafeMarkup::setMultiple([$string => ['html' => TRUE]]); - return $string; - } - else { - return SafeMarkup::format($string, $args); - } + return new TranslationWrapper($string, $args, $options); } /** - * Translates a string to the current language or to a given language. - * - * @param string $string - * A string containing the English string to translate. - * @param array $options - * An associative array of additional options, with the following elements: - * - 'langcode': The language code to translate to a language other than - * what is used to display the page. - * - 'context': The context the source string belongs to. - * - * @return string - * The translated string. + * {@inheritdoc} */ - protected function doTranslate($string, array $options = array()) { + public function translateToString($string, array $args = array(), array $options = array()) { // Merge in defaults. if (empty($options['langcode'])) { $options['langcode'] = $this->defaultLangcode; @@ -180,7 +158,11 @@ protected function doTranslate($string, array $options = array()) { $options['context'] = ''; } $translation = $this->getStringTranslation($options['langcode'], $string, $options['context']); - return $translation === FALSE ? $string : $translation; + $value = $translation === FALSE ? $string : $translation; + if (!empty($args)) { + $value = $this->placeholderFormat($value, $args); + } + return $value; } /** @@ -188,7 +170,7 @@ protected function doTranslate($string, array $options = array()) { */ public function formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) { $translatable_string = implode(LOCALE_PLURAL_DELIMITER, array($singular, $plural)); - $translated_strings = $this->doTranslate($translatable_string, $options); + $translated_strings = $this->translateToString($translatable_string, array(), $options); return $this->formatPluralTranslated($count, $translated_strings, $args, $options); } diff --git a/core/lib/Drupal/Core/StringTranslation/TranslationWrapper.php b/core/lib/Drupal/Core/StringTranslation/TranslationWrapper.php index 10e9b12..013cb2d 100644 --- a/core/lib/Drupal/Core/StringTranslation/TranslationWrapper.php +++ b/core/lib/Drupal/Core/StringTranslation/TranslationWrapper.php @@ -59,6 +59,9 @@ class TranslationWrapper implements SafeStringInterface { * (optional) An array of additional options. */ public function __construct($string, array $arguments = array(), array $options = array()) { + // We disallow passing in non-string values such as when we translate + // an already translated value. + assert('is_string($string)', 'Non-string value passed in: ' . (string) $string); $this->string = $string; $this->arguments = $arguments; $this->options = $options; @@ -96,6 +99,7 @@ public function getOption($name) { public function getOptions() { return $this->options; } + /** * Renders the object as a string. * @@ -103,7 +107,10 @@ public function getOptions() { * The translated string. */ public function render() { - return $this->t($this->string, $this->arguments, $this->options); + if ($this->string === '') { + return ''; + } + return $this->getStringTranslation()->translateToString($this->string, $this->arguments, $this->options); } /** @@ -123,5 +130,4 @@ public function jsonSerialize() { return $this->__toString(); } - } diff --git a/core/lib/Drupal/Core/Template/Attribute.php b/core/lib/Drupal/Core/Template/Attribute.php index cc0d591..76d7c6a 100644 --- a/core/lib/Drupal/Core/Template/Attribute.php +++ b/core/lib/Drupal/Core/Template/Attribute.php @@ -109,7 +109,8 @@ protected function createAttributeValue($name, $value) { elseif (is_bool($value)) { $value = new AttributeBoolean($name, $value); } - elseif (!is_object($value)) { + // As a development aid, we allow the value to be a safe string object. + elseif (!is_object($value) || $value instanceof SafeStringInterface) { $value = new AttributeString($name, $value); } return $value; diff --git a/core/lib/Drupal/Core/Validation/DrupalTranslator.php b/core/lib/Drupal/Core/Validation/DrupalTranslator.php index a2bbf5b..ba1a1f9 100644 --- a/core/lib/Drupal/Core/Validation/DrupalTranslator.php +++ b/core/lib/Drupal/Core/Validation/DrupalTranslator.php @@ -7,6 +7,8 @@ namespace Drupal\Core\Validation; +use Drupal\Component\Utility\SafeStringInterface; + /** * Translates strings using Drupal's translation system. * @@ -73,8 +75,14 @@ public function getLocale() { protected function processParameters(array $parameters) { $return = array(); foreach ($parameters as $key => $value) { + // We allow the values in the parameters to be safe string objects. This + // can be useful when we want to use parameter values that are + // TranslationWrappers. + if ($value instanceof SafeStringInterface) { + $value = (string) $value; + } if (is_object($value)) { - // t() does not work will objects being passed as replacement strings. + // t() does not work with objects being passed as replacement strings. } // Check for symfony replacement patterns in the form "{{ name }}". elseif (strpos($key, '{{ ') === 0 && strrpos($key, ' }}') == strlen($key) - 3) { diff --git a/core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidator.php b/core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidator.php index d873820..6fa8771 100644 --- a/core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidator.php +++ b/core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidator.php @@ -16,6 +16,7 @@ use Drupal\Core\TypedData\Type\StringInterface; use Drupal\Core\TypedData\Type\UriInterface; use Drupal\Core\TypedData\Validation\TypedDataAwareValidatorTrait; +use Drupal\Component\Utility\SafeStringInterface; use Symfony\Component\Validator\Constraint; use Symfony\Component\Validator\ConstraintValidator; @@ -49,7 +50,7 @@ public function validate($value, Constraint $constraint) { if ($typed_data instanceof IntegerInterface && filter_var($value, FILTER_VALIDATE_INT) === FALSE) { $valid = FALSE; } - if ($typed_data instanceof StringInterface && !is_scalar($value)) { + if ($typed_data instanceof StringInterface && !is_scalar($value) && !($value instanceof SafeStringInterface)) { $valid = FALSE; } // Ensure that URIs comply with http://tools.ietf.org/html/rfc3986, which diff --git a/core/modules/ckeditor/ckeditor.admin.inc b/core/modules/ckeditor/ckeditor.admin.inc index d5bb690..9120763 100644 --- a/core/modules/ckeditor/ckeditor.admin.inc +++ b/core/modules/ckeditor/ckeditor.admin.inc @@ -117,8 +117,6 @@ function template_preprocess_ckeditor_settings_toolbar(&$variables) { $variables['active_buttons'] = array(); foreach ($active_buttons as $row_number => $button_row) { foreach ($button_groups[$row_number] as $group_name) { - // We cast the group name to string as array keys must not be objects - // and t() may return a TranslationWrapper once issue #2557113 lands. $group_name = (string) $group_name; $variables['active_buttons'][$row_number][$group_name] = array( 'group_name_class' => Html::getClass($group_name), diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module index edd20a0..8bc499f 100644 --- a/core/modules/comment/comment.module +++ b/core/modules/comment/comment.module @@ -299,8 +299,6 @@ function comment_form_field_ui_field_storage_add_form_alter(&$form, FormStateInt $form['#title'] = \Drupal::service('comment.manager')->getFieldUIPageTitle($route_match->getParameter('commented_entity_type'), $route_match->getParameter('field_name')); } if (!_comment_entity_uses_integer_id($form_state->get('entity_type_id'))) { - // We cast the optgroup label to string as array keys must not be objects - // and t() will return a TranslationWrapper once issue #2557113 lands. $optgroup = (string) t('General'); // You cannot use comment fields on entity types with non-integer IDs. unset($form['add']['new_storage_type']['#options'][$optgroup]['comment']); diff --git a/core/modules/config_translation/config_translation.module b/core/modules/config_translation/config_translation.module index 3c81f78..7644f3e 100644 --- a/core/modules/config_translation/config_translation.module +++ b/core/modules/config_translation/config_translation.module @@ -115,7 +115,7 @@ function config_translation_config_translation_info(&$info) { $info[$entity_type_id . '_fields'] = array( 'base_route_name' => "entity.field_config.{$entity_type_id}_field_edit_form", 'entity_type' => 'field_config', - 'title' => '!label field', + 'title' => '@label field', 'class' => '\Drupal\config_translation\ConfigFieldMapper', 'base_entity_type' => $entity_type_id, 'weight' => 10, @@ -144,7 +144,7 @@ function config_translation_config_translation_info(&$info) { $info[$entity_type_id] = array( 'class' => '\Drupal\config_translation\ConfigEntityMapper', 'base_route_name' => $base_route_name, - 'title' => '!label !entity_type', + 'title' => '@label @entity_type', 'names' => array(), 'entity_type' => $entity_type_id, 'weight' => 10, diff --git a/core/modules/config_translation/src/ConfigEntityMapper.php b/core/modules/config_translation/src/ConfigEntityMapper.php index 4a6d275..d454bb8 100644 --- a/core/modules/config_translation/src/ConfigEntityMapper.php +++ b/core/modules/config_translation/src/ConfigEntityMapper.php @@ -158,7 +158,7 @@ public function getTitle() { // current page language. The title placeholder is later escaped for // display. $entity_type_info = $this->entityManager->getDefinition($this->entityType); - return $this->t($this->pluginDefinition['title'], array('!label' => $this->entity->label(), '!entity_type' => $entity_type_info->getLowercaseLabel())); + return $this->t($this->pluginDefinition['title'], array('@label' => $this->entity->label(), '@entity_type' => $entity_type_info->getLowercaseLabel())); } /** diff --git a/core/modules/entity_reference/entity_reference.module b/core/modules/entity_reference/entity_reference.module index 908e0e5..ae4cc03 100644 --- a/core/modules/entity_reference/entity_reference.module +++ b/core/modules/entity_reference/entity_reference.module @@ -126,8 +126,6 @@ function entity_reference_field_config_presave(FieldConfigInterface $field) { * Implements hook_form_FORM_ID_alter() for 'field_ui_field_storage_add_form'. */ function entity_reference_form_field_ui_field_storage_add_form_alter(array &$form) { - // We cast the optgroup label to string as array keys must not be objects - // and t() may return a TranslationWrapper once issue #2557113 lands. $optgroup = (string) t('Reference'); // Move the "Entity reference" option to the end of the list and rename it to // "Other". diff --git a/core/modules/language/src/Form/NegotiationBrowserForm.php b/core/modules/language/src/Form/NegotiationBrowserForm.php index 111f35a..5fa186a 100644 --- a/core/modules/language/src/Form/NegotiationBrowserForm.php +++ b/core/modules/language/src/Form/NegotiationBrowserForm.php @@ -82,8 +82,6 @@ public function buildForm(array $form, FormStateInterface $form_state) { } else { $language_options = array( - // We cast the optgroup labels to string as array keys must not be objects - // and t() may return a TranslationWrapper once issue #2557113 lands. (string) $this->t('Existing languages') => $existing_languages, (string) $this->t('Languages not yet added') => $this->languageManager->getStandardLanguageListWithoutConfigured(), ); diff --git a/core/modules/locale/src/Form/ImportForm.php b/core/modules/locale/src/Form/ImportForm.php index 86aecc3..f3007f6 100644 --- a/core/modules/locale/src/Form/ImportForm.php +++ b/core/modules/locale/src/Form/ImportForm.php @@ -94,8 +94,6 @@ public function buildForm(array $form, FormStateInterface $form_state) { else { $default = key($existing_languages); $language_options = array( - // We cast the optgroup labels to string as array keys must not be objects - // and t() may return a TranslationWrapper once issue #2557113 lands. (string) $this->t('Existing languages') => $existing_languages, (string) $this->t('Languages not yet added') => $this->languageManager->getStandardLanguageListWithoutConfigured(), ); diff --git a/core/modules/locale/src/Tests/LocaleTranslationUiTest.php b/core/modules/locale/src/Tests/LocaleTranslationUiTest.php index 6c35b18..53ad166 100644 --- a/core/modules/locale/src/Tests/LocaleTranslationUiTest.php +++ b/core/modules/locale/src/Tests/LocaleTranslationUiTest.php @@ -64,7 +64,7 @@ public function testStringTranslation() { ); $this->drupalPostForm('admin/config/regional/language/add', $edit, t('Add custom language')); // Add string. - t($name, array(), array('langcode' => $langcode)); + t($name, array(), array('langcode' => $langcode))->render(); // Reset locale cache. $this->container->get('string_translation')->reset(); $this->assertRaw('"edit-languages-' . $langcode . '-weight"', 'Language code found.'); @@ -302,7 +302,7 @@ public function testStringValidation() { ); $this->drupalPostForm('admin/config/regional/language/add', $edit, t('Add custom language')); // Add string. - t($name, array(), array('langcode' => $langcode)); + t($name, array(), array('langcode' => $langcode))->render(); // Reset locale cache. $search = array( 'string' => $name, @@ -361,7 +361,7 @@ public function testStringSearch() { $this->drupalPostForm('admin/config/regional/language/add', $edit, t('Add custom language')); // Add string. - t($name, array(), array('langcode' => $langcode)); + t($name, array(), array('langcode' => $langcode))->render(); // Reset locale cache. $this->container->get('string_translation')->reset(); $this->drupalLogout(); diff --git a/core/modules/system/src/Tests/Form/FormTest.php b/core/modules/system/src/Tests/Form/FormTest.php index 83b9129..389d23e 100644 --- a/core/modules/system/src/Tests/Form/FormTest.php +++ b/core/modules/system/src/Tests/Form/FormTest.php @@ -144,7 +144,7 @@ function testRequiredFields() { // Select elements are going to have validation errors with empty // input, since those are illegal choices. Just make sure the // error is not "field is required". - $this->assertTrue((empty($errors[$element]) || strpos('field is required', $errors[$element]) === FALSE), "Optional '$type' field '$element' is not treated as a required element"); + $this->assertTrue((empty($errors[$element]) || strpos('field is required', (string) $errors[$element]) === FALSE), "Optional '$type' field '$element' is not treated as a required element"); } else { // Make sure there is *no* form error for this element. diff --git a/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php b/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php index e435c0a..c26ea9b 100644 --- a/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php +++ b/core/modules/system/tests/modules/plugin_test/src/Plugin/MockBlockManager.php @@ -78,7 +78,7 @@ public function __construct() { 'label' => t('User name'), 'class' => 'Drupal\plugin_test\Plugin\plugin_test\mock_block\MockUserNameBlock', 'context' => array( - 'user' => new ContextDefinition('entity:user', t('User')), + 'user' => $this->createContextDefinitionWithStringLabel('entity:user', t('User')), ), )); @@ -87,7 +87,7 @@ public function __construct() { 'label' => t('User name optional'), 'class' => 'Drupal\plugin_test\Plugin\plugin_test\mock_block\MockUserNameBlock', 'context' => array( - 'user' => new ContextDefinition('entity:user', t('User'), FALSE), + 'user' => $this->createContextDefinitionWithStringLabel('entity:user', t('User'), FALSE), ), )); @@ -102,8 +102,8 @@ public function __construct() { 'label' => t('Complex context'), 'class' => 'Drupal\plugin_test\Plugin\plugin_test\mock_block\MockComplexContextBlock', 'context' => array( - 'user' => new ContextDefinition('entity:user', t('User')), - 'node' => new ContextDefinition('entity:node', t('Node')), + 'user' => $this->createContextDefinitionWithStringLabel('entity:user', t('User')), + 'node' => $this->createContextDefinitionWithStringLabel('entity:node', t('Node')), ), )); @@ -118,4 +118,24 @@ public function __construct() { // specified), so we provide it the discovery object. $this->factory = new ReflectionFactory($this->discovery); } + + /** + * Creates a new context definition with a label that is cast to string. + * + * @param string $data_type + * The required data type. + * @param mixed string|null $label + * The label of this context definition for the UI. + * @param bool $required + * Whether the context definition is required. + * + * @return \Drupal\Core\Plugin\Context\ContextDefinition + */ + protected function createContextDefinitionWithStringLabel($data_type, $label, $required = TRUE) { + // We cast the label to string for testing purposes only, as it may be + // a TranslationWrapper and we will do assertEqual() checks on arrays that + // include ContextDefinition objects, and var_export() has problems + // printing TranslationWrapper objects. + return new ContextDefinition($data_type, (string) $label, $required); + } } diff --git a/core/modules/user/src/Tests/UserCancelTest.php b/core/modules/user/src/Tests/UserCancelTest.php index 5357013..648f56f 100644 --- a/core/modules/user/src/Tests/UserCancelTest.php +++ b/core/modules/user/src/Tests/UserCancelTest.php @@ -535,7 +535,7 @@ function testMassUserCancelByAdmin() { $this->drupalPostForm(NULL, NULL, t('Cancel accounts')); $status = TRUE; foreach ($users as $account) { - $status = $status && (strpos($this->content, t('%name has been deleted.', array('%name' => $account->getUsername()))) !== FALSE); + $status = $status && (strpos($this->content, $account->getUsername() . ' has been deleted.') !== FALSE); $user_storage->resetCache(array($account->id())); $status = $status && !$user_storage->load($account->id()); } diff --git a/core/modules/views/src/Plugin/views/PluginBase.php b/core/modules/views/src/Plugin/views/PluginBase.php index 4dff979..3e567a5 100644 --- a/core/modules/views/src/Plugin/views/PluginBase.php +++ b/core/modules/views/src/Plugin/views/PluginBase.php @@ -15,6 +15,7 @@ use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Drupal\Core\Plugin\PluginBase as ComponentPluginBase; use Drupal\Core\Render\Element; +use Drupal\Core\StringTranslation\TranslationWrapper; use Drupal\views\Plugin\views\display\DisplayPluginBase; use Drupal\views\ViewExecutable; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -562,7 +563,14 @@ protected function listLanguages($flags = LanguageInterface::STATE_ALL, array $c // Since this is not a real language, surround it by '***LANGUAGE_...***', // like the negotiated languages below. if ($flags & LanguageInterface::STATE_SITE_DEFAULT) { - $list[PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT] = $this->t($languages[LanguageInterface::LANGCODE_SITE_DEFAULT]->getName()); + $name = $languages[LanguageInterface::LANGCODE_SITE_DEFAULT]->getName(); + // The language name may have already been translated, no need to + // translate it again. + // @see Drupal\Core\Language::filterLanguages(). + if (!$name instanceof TranslationWrapper) { + $name = $this->t($name); + } + $list[PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT] = $name; // Remove site default language from $languages so it's not added // twice with the real languages below. unset($languages[LanguageInterface::LANGCODE_SITE_DEFAULT]); diff --git a/core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php b/core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php index 2e4564e..1a97ee5 100644 --- a/core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php +++ b/core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php @@ -52,8 +52,6 @@ public function tokenForm(&$form, FormStateInterface $form_state) { // Get a list of the available fields and arguments for token replacement. $options = array(); - // We cast the optgroup labels to string as array keys must not be objects - // and t() may return a TranslationWrapper once issue #2557113 lands. $optgroup_arguments = (string) t('Arguments'); $optgroup_fields = (string) t('Fields'); foreach ($this->view->display_handler->getHandlers('field') as $field => $handler) { diff --git a/core/modules/views/src/Plugin/views/display/DisplayPluginBase.php b/core/modules/views/src/Plugin/views/display/DisplayPluginBase.php index 1bb3394..76ae608 100644 --- a/core/modules/views/src/Plugin/views/display/DisplayPluginBase.php +++ b/core/modules/views/src/Plugin/views/display/DisplayPluginBase.php @@ -1725,9 +1725,6 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) { ); $options = array(); - // We cast the optgroup label to string as array keys must not be - // objects and t() may return a TranslationWrapper once issue #2557113 - // lands. $optgroup_arguments = (string) t('Arguments'); foreach ($this->view->display_handler->getHandlers('argument') as $arg => $handler) { $options[$optgroup_arguments]["{{ arguments.$arg }}"] = $this->t('@argument title', array('@argument' => $handler->adminLabel())); diff --git a/core/modules/views/src/Plugin/views/field/FieldPluginBase.php b/core/modules/views/src/Plugin/views/field/FieldPluginBase.php index 7ed1033..c1ea93d 100644 --- a/core/modules/views/src/Plugin/views/field/FieldPluginBase.php +++ b/core/modules/views/src/Plugin/views/field/FieldPluginBase.php @@ -862,8 +862,6 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) { // Setup the tokens for fields. $previous = $this->getPreviousFieldLabels(); - // We cast the optgroup labels to string as array keys must not be objects - // and t() may return a TranslationWrapper once issue #2557113 lands. $optgroup_arguments = (string) t('Arguments'); $optgroup_fields = (string) t('Fields'); foreach ($previous as $id => $label) { diff --git a/core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php b/core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php index be8cca3..6d153ce 100644 --- a/core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php +++ b/core/tests/Drupal/Tests/Core/Annotation/TranslationTest.php @@ -46,7 +46,7 @@ public function testGet(array $values, $expected) { 'context' => $values['context'], ) : array(); $this->translationManager->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with($values['value'], $arguments, $options); $annotation = new Translation($values); diff --git a/core/tests/Drupal/Tests/Core/Menu/ContextualLinkDefaultTest.php b/core/tests/Drupal/Tests/Core/Menu/ContextualLinkDefaultTest.php index ac92088..de32fd3 100644 --- a/core/tests/Drupal/Tests/Core/Menu/ContextualLinkDefaultTest.php +++ b/core/tests/Drupal/Tests/Core/Menu/ContextualLinkDefaultTest.php @@ -74,7 +74,7 @@ public function testGetTitle() { $this->pluginDefinition['title'] = (new TranslationWrapper($title)) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with($title, array(), array()) ->will($this->returnValue('Example translated')); @@ -90,7 +90,7 @@ public function testGetTitleWithContext() { $this->pluginDefinition['title'] = (new TranslationWrapper($title, array(), array('context' => 'context'))) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with($title, array(), array('context' => 'context')) ->will($this->returnValue('Example translated with context')); @@ -106,7 +106,7 @@ public function testGetTitleWithTitleArguments() { $this->pluginDefinition['title'] = (new TranslationWrapper($title, array('@test' => 'value'))) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with($title, array('@test' => 'value'), array()) ->will($this->returnValue('Example value')); diff --git a/core/tests/Drupal/Tests/Core/Menu/LocalActionDefaultTest.php b/core/tests/Drupal/Tests/Core/Menu/LocalActionDefaultTest.php index 02d4578..dceb4de 100644 --- a/core/tests/Drupal/Tests/Core/Menu/LocalActionDefaultTest.php +++ b/core/tests/Drupal/Tests/Core/Menu/LocalActionDefaultTest.php @@ -86,7 +86,7 @@ public function testGetTitle() { $this->pluginDefinition['title'] = (new TranslationWrapper('Example')) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with('Example', array(), array()) ->will($this->returnValue('Example translated')); @@ -103,7 +103,7 @@ public function testGetTitleWithContext() { $this->pluginDefinition['title'] = (new TranslationWrapper('Example', array(), array('context' => 'context'))) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with('Example', array(), array('context' => 'context')) ->will($this->returnValue('Example translated with context')); @@ -118,7 +118,7 @@ public function testGetTitleWithTitleArguments() { $this->pluginDefinition['title'] = (new TranslationWrapper('Example @test', array('@test' => 'value'))) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with('Example @test', array('@test' => 'value'), array()) ->will($this->returnValue('Example value')); diff --git a/core/tests/Drupal/Tests/Core/Menu/LocalTaskDefaultTest.php b/core/tests/Drupal/Tests/Core/Menu/LocalTaskDefaultTest.php index d4032ec..41b27e9 100644 --- a/core/tests/Drupal/Tests/Core/Menu/LocalTaskDefaultTest.php +++ b/core/tests/Drupal/Tests/Core/Menu/LocalTaskDefaultTest.php @@ -236,7 +236,7 @@ public function testGetTitle() { $this->pluginDefinition['title'] = (new TranslationWrapper('Example')) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with('Example', array(), array()) ->will($this->returnValue('Example translated')); @@ -252,7 +252,7 @@ public function testGetTitleWithContext() { $this->pluginDefinition['title'] = (new TranslationWrapper($title, array(), array('context' => 'context'))) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with($title, array(), array('context' => 'context')) ->will($this->returnValue('Example translated with context')); @@ -268,7 +268,7 @@ public function testGetTitleWithTitleArguments() { $this->pluginDefinition['title'] = (new TranslationWrapper('Example @test', array('@test' => 'value'))) ->setStringTranslation($this->stringTranslation); $this->stringTranslation->expects($this->once()) - ->method('translate') + ->method('translateToString') ->with($title, array('@test' => 'value'), array()) ->will($this->returnValue('Example value')); diff --git a/core/tests/Drupal/Tests/Core/StringTranslation/TranslationWrapperTest.php b/core/tests/Drupal/Tests/Core/StringTranslation/TranslationWrapperTest.php index 3facf38..db977cd 100644 --- a/core/tests/Drupal/Tests/Core/StringTranslation/TranslationWrapperTest.php +++ b/core/tests/Drupal/Tests/Core/StringTranslation/TranslationWrapperTest.php @@ -66,7 +66,7 @@ public function testToString() { ->willReturn(''); $translation = $this->prophesize(TranslationInterface::class); - $translation->translate($string, [], [])->will(function () { + $translation->translateToString($string, [], [])->will(function () { throw new \Exception('Yes you may.'); }); $text->setStringTranslation($translation->reveal()); diff --git a/core/tests/Drupal/Tests/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidatorTest.php b/core/tests/Drupal/Tests/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidatorTest.php index 2bcb318..0707fa3 100644 --- a/core/tests/Drupal/Tests/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidatorTest.php +++ b/core/tests/Drupal/Tests/Core/Validation/Plugin/Validation/Constraint/PrimitiveTypeConstraintValidatorTest.php @@ -16,6 +16,7 @@ use Drupal\Core\TypedData\PrimitiveInterface; use Drupal\Core\Validation\Plugin\Validation\Constraint\PrimitiveTypeConstraint; use Drupal\Core\Validation\Plugin\Validation\Constraint\PrimitiveTypeConstraintValidator; +use Drupal\Core\StringTranslation\TranslationWrapper; use Drupal\Tests\UnitTestCase; /** @@ -63,6 +64,7 @@ public function provideTestValidate() { $data[] = [new IntegerData(DataDefinition::create('integer')), 1.5, FALSE]; $data[] = [new IntegerData(DataDefinition::create('integer')), 'test', FALSE]; $data[] = [new StringData(DataDefinition::create('string')), 'test', TRUE]; + $data[] = [new StringData(DataDefinition::create('string')), new TranslationWrapper('test'), TRUE]; // It is odd that 1 is a valid string. // $data[] = [$this->getMock('Drupal\Core\TypedData\Type\StringInterface'), 1, FALSE]; $data[] = [new StringData(DataDefinition::create('string')), [], FALSE]; diff --git a/core/tests/Drupal/Tests/UnitTestCase.php b/core/tests/Drupal/Tests/UnitTestCase.php index 3433c94..a48219b 100644 --- a/core/tests/Drupal/Tests/UnitTestCase.php +++ b/core/tests/Drupal/Tests/UnitTestCase.php @@ -12,6 +12,7 @@ use Drupal\Component\Utility\SafeMarkup; use Drupal\Core\Cache\CacheTagsInvalidatorInterface; use Drupal\Core\DependencyInjection\ContainerBuilder; +use Drupal\Component\Utility\PlaceholderTrait; /** * Provides a base class and helpers for Drupal unit tests. @@ -20,6 +21,8 @@ */ abstract class UnitTestCase extends \PHPUnit_Framework_TestCase { + use PlaceholderTrait; + /** * The random generator. * @@ -220,6 +223,11 @@ public function getStringTranslationStub() { ->willReturnCallback(function ($count, $singular, $plural, array $args = [], array $options = []) { return $count === 1 ? SafeMarkup::format($singular, $args) : SafeMarkup::format($plural, $args + ['@count' => $count]); }); + $translation->expects($this->any()) + ->method('translateToString') + ->willReturnCallback(function ($string, array $args = [], array $options = []) { + return $this->placeholderFormat($string, $args); + }); return $translation; }