Update ConfigFieldPlugin.php

[sebastian-ehrling]

Improvement of comment translations in the store settings.

[avstudnitz]

Doesn't this exactly reverse what we did in the lines before?

We are transforming a phrase into text and arguments:

            $phrase = $result;
            $result = $phrase->getText();
            $arguments = $phrase->getArguments();

And then we are transforming it back to a phrase with the same text and arguments as before:

$result = new Phrase($result, $arguments);

The original code transformed a phrase into a string, appended another string and then transformed it back to a phrase.

@sebastian-ehrling Can you explain how your change works?

[sebastian-ehrling]

Hi Andreas,

thx for your comment. With your plugin for the method getComment the original comments will not be translated anymore. This is because the phrase to translate contains the information about the current config path.

With my modification, we translate the comment phrase before adding the path information.

[schmengler]

The difference is that $phrase->getText() returns the untranslated text and $phrase->__toString() (implicitly called later) returns the translated string.

I assume that the original $result can be a Phrase if the comment is translatable or a string if not. So we can also return a string instead of a Phrase (and should! it's not a single translatable text anymore)

If my assuptions are correct, the fix in the PR will work but it can be done simpler:

    public function afterGetComment(Subject $subject, $result)
        if ($result instanceof Phrase) {
            $result = (string) $result;
        }
        if (strlen(trim($result))) {
            $result .= '<br />';
        }
        $result .= __('Path: <code>%1</code>', $this->getPath($subject));
        return $result;
    }

[avstudnitz]

Closed because the fix has been implemented in #34. using @schmengler 's code and @sebastian-ehrling 's original approach.