Internationalization topic refers to format_plural() function that does not exist

StringTranslationTrait::formatPlural() still exists:
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!StringTranslation...

So the advice to use the formatPlural() method if it exists on a class, and to use the trait to get this method, is still good.

However, you're right that the "global formatPlural() function" doesn't exist. In a global scope, the correct advice would be to use PluralTranslatableMarkup::createFromTranslatedString().

https://api.drupal.org/api/drupal/core!lib!Drupal!Core!StringTranslation...

Should be a good novice project to update that part of the docs.

Thanks! Almost there, but it needs a bit of work:

1. +++ b/core/lib/Drupal/Core/Language/language.api.php
   @@ -28,10 +28,10 @@
   + *   PluralTranslatableMarkup::createFromTranslatedString(), in a global scope,
   

   This needs to have the namespace, starting with \, on the PluralTranslatableMarkup class.

2. +++ b/core/lib/Drupal/Core/Language/language.api.php
   @@ -28,10 +28,10 @@
   + *   or a formatPlural() method in the class
   + *   \Drupal\Core\StringTranslation\StringTranslationTrait.
   

   The previous wording that this patch replaces was better, regarding what to do on a class. Can we get that back please?

@jhodgdon

I worked on your above comments.

But i need your help for following

+ *   involves plurals, it should be passed through either
+ *   use \Drupal\Core\StringTranslation\PluralTranslatableMarkup::createFromTranslatedString(),
+ *   in a global scope,

with namespace it is crossing 80 characters, what can be done here?

Just put the too-long thing on one line. We make exceptions to line lengths for namespaces being too long in docs, since there is no solution, but it needs to be by itself on a line so that it goes over by the minimal amount. Thanks!

So in this patch:

1. +++ b/core/lib/Drupal/Core/Language/language.api.php
   @@ -28,10 +28,12 @@
   + *   use \Drupal\Core\StringTranslation\PluralTranslatableMarkup::createFromTranslatedString(),
   

   the word "use" should be removed on this line. Then just leave it as it is, and do not worry about the 80-character limit.

2. +++ b/core/lib/Drupal/Core/Language/language.api.php
   @@ -28,10 +28,12 @@
   + *   Use\Drupal\Core\StringTranslation\StringTranslationTrait to get these
   

   We need a space after the word "Use" here.

@jhodgdon

I made the changes according to #6.

The last patch did not apply.
Rerolled #7.

I thought it would be more correct to link the following lines into one:

+++ b/core/lib/Drupal/Core/Language/language.api.php
@@ -29,10 +29,10 @@
  *   in a global scope,
  *   or a formatPlural() method on the class.

@jhodgdon This change would be right?

Needs work for #10.

+++ b/core/lib/Drupal/Core/Language/language.api.php
@@ -28,10 +28,11 @@
+ *   in a global scope, or a formatPlural() method on the class.
+ *   Use \Drupal\Core\StringTranslation\StringTranslationTrait to get these
+ *   methods into a class.

Also these three lines still need to be rewrapped so that all docs lines get as close to 80 characters as possible. (Of course, rewrap after the rewording!)

Apply changes mentioned on #10, #11.

@jhodgdon, I have a question.
We need to work to get as close to 80 characters throughout the document? Or only in this block?
I had doubts about this.
Thanks!

Looking at this issue, the next step is to review the patch and address @dimaro's comments above. It looks like a good novice task according to https://www.drupal.org/core-mentoring/novice-tasks.

All documentation blocks and // comments should be wrapped to go as close to 80 characters as possible, without going over. In some cases (as discussed above, for instance), we allow lines to go over 80 charactres. But probably you shouldn't go fix anything else in this file on this patch, just the area being worked on.

So... it's still not fixed:

+++ b/core/lib/Drupal/Core/Language/language.api.php
@@ -29,9 +29,10 @@
+ *   or a formatPlural() method on the class.
+ *   Use \Drupal\Core\StringTranslation\StringTranslationTrait to get these
+ *   methods into a class.

The wording looks good now to me, but these lines are still not wrapped to get as close to 80 characters as possible in each line. Please fix this.

Thanks @jhodgdon.
Would be correct now?

@dimaro

adjusted patch as suggested by @jhodgdon in #14

Attaching interdiff file

I have taken a look at #17 and have affirmed that :
\Drupal\Core\StringTranslation\PluralTranslatableMarkup::createFromTranslatedString() cannot be shortened to be restricted within the 80chars as a single line.
Converting this to RTBC.

@webchick committed this issue LIVE at DrupalCon Asia!

I cherry-picked the commit to 8.0.x since we had some git fun onstage. ;)

(And adding in the issue credits!)

Uh oh, good catch on the code block! We should definitely fix that.

Regarding the first question, yes createFromTranslatedString() is the Best Way (TM) to do this, even though it is not the most common in the code base right now, because it was introduced relatively recently.

Hi @jhodgdon and @eojthebrave

here is modified code sample picked from https://api.drupal.org/api/drupal/core%21modules%21locale%21src%21Tests%...

 * // PHP code
 * t('May', array(), array('context' => 'Long month name');
 * $translated_string = \Drupal::translation()->translate('1 something' .
 *   PluralTranslatableMarkup::DELIMITER . '@count somethings', array(),
 *   array('langcode' => $langcode));
 * $plural = PluralTranslatableMarkup::createFromTranslatedString($count,
 *    $translated_string, array(), array('langcode' => $langcode));

can you confirm, if so i will create patch with this.

Hi @kannan@kiluvai.com,

In general, it's best to post the patch first and then contributors can review it in context. Posting patches that are not perfect is part of the process. :)

However, in this case, part of that code snippet looks incorrect. I'd suggest not using a test for the API itself as a model. It would be better to look for use of formatPlural() in module code to use as an example.

Echo what xjm said. ... So, a more normal way to use the PluralTranslatableMarkup object is to do a call like this:

$foo = new PluralTranslatableMarkup($count, '1 cow', '@count cows');

Created patch for this and attached.

I have picked the code sample from https://api.drupal.org/api/drupal/core%21includes%21common.inc/8 line no 253

\Drupal::translation()->formatPlural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));

formatPlural function using the PluralTranslatableMarkup class, so i thought formatPlural will be right choice to use.

Um, this latest patch has lost the changes from #17 that we still need (well, we need it but we need it to be fixed).

@jhodgdon #17 was commited no?

I try to join #17 and #31, but #17 is already in 8.0.x.

Oh, you're right, sorry!

OK. Looking at what we currently have on
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Language!language...
vs. the patch... you are right, the patch is complete as far as what needs to be fixed.

But

+++ b/core/lib/Drupal/Core/Language/language.api.php
@@ -111,8 +111,8 @@
- * format_plural($count, '1 something', '@count somethings',
- *   array(), array('context' => 'My context'));
+ * \Drupal::translation()->formatPlural($count, '1 cow', '@count cows', array(),

Probably we should keep the same example that was in this code before: 1 something / @count somethings, rather than changing to cows.

Oh. Also there appears to be an @see format_plural() at the bottom of this doc block. That should also be fixed, or just removed.

Apply changes mentioned on #35 and #36.
On 8.0.x there was no word 'cow/s', only in #31 (See interdiff).

I removed @see format_plural()
Would be right?

Thanks! That looks right to me.

Committed/pushed to 8.2.x and cherry-picked to 8.1.x and 8.0.x. Thanks!