text collector doesn't collect when parameters are passed as a variable

[lekoala]

Module version(s) affected

5.x

Description

the method collectFromCode doesn't collect if the third argument is a variable instead of a plain array. This makes using _t not very practical if you reuse injection arguments in multiple strings.

eg from my project

Here is some code

$metaDescription = _t(
    'Controller.Someentity',
    "Meet {name} {address}",
    $args
);

is never collected

    $metaDescription = _t(
      'Controller.Someentity',
      "Meet {name} {address}",
      [
          'name' => $office->Name,
          'city' => $city,
          'address' => $address->StreetAddress . " " . $address->PostalCode . ". " . $address->City
      ];
);

works fine

How to reproduce

In a controller, have

        $var = ['some' => 'var'];
        $ImNOTCollected = _t('PageController.ImNOTCollected', 'test {some}', $var);
        $ImCollected = _t('PageController.ImCollected', 'test {some}', ['some' => 'var']);

Run text collector

=> ImNOTCollected is not there

Possible Solution

No response

Additional Context

No response

Validations

• Check that there isn't already an issue that reports the same bug
• Double check that your reproduction steps work in a fresh installation of silverstripe/installer (with any code examples you've provided)

PRs

• FIX Invalid _t usage #11522
• FEAT support variables as second and third argument #11521

[lekoala]

current fix if you have the issue, if you can live with a silly syntax ;-)

$ImCollectedAgain = _t('PageController.ImNOTCollected', 'test {some}', [...$var]);

[GuySartorelli]

I don't know that this is a bug so much as a desired enhancement. The text collector relies on what is currently a pretty crude hand-made static analysis. The capability to figure out what's in a variable would be a new capability, I think.

[lekoala]

well, at least it could complain or make some kind of error. Or at least be documented here https://docs.silverstripe.org/en/5/developer_guides/i18n/#usage-in-php-files
at the moment it fails silently even though i have a _t function
even a regex would do a better job :)

[lekoala]

it also doesn't work on this

silverstripe-framework/src/Dev/BulkLoader.php

Line 175 in 754ac17

_t(__CLASS__ . '.CANNOT_DELETE', "Not allowed to delete '$type' records"),

due to $type being a variable and not parsed correctly (but that is easily fixable by replacing . $type . by {type} and pass the type as context

[lekoala]

@GuySartorelli i'm working on a PR that works with the relevant use cases. I think it makes a lot of sense in many places to be able to use variables as either the second or third argument