While checking the Glossary 2 module → with phpstan, I noticed a warning about the setError method.
FormStateInterface::setError() is defined as:
/**
* ...snip..
* @param string $message
* (optional) The error message to present to the user.
* ...snip..
*/
public function setError(array &$element, $message = '');
However, most (82) implementations in core actually take a TranslatableMarkup for the $message parameter.
The 23 exceptions are:
"", being self-consistent""""'Fail''Sorry system error. Please save again.''Provide a value for the sizes attribute.' and 'Select at least one image style.', which looks like they should actually be translatedweb/core/modules/views/src/Plugin/views/display/PathPluginBase.php passing an $error, which is actually always a TranslatableMarkup.Compare the outputs of
grep -irE "setError\([^\)]" web/core | cut -c1-180 | grep -E '(this->t|this->formatPlural| t|new TranslatableMarkup)\('grep -irE "setError\([^\)]" web/core | cut -c1-180 | grep -vE '(this->t|this->formatPlural| t|new TranslatableMarkup)\('setError to match what code actually does: update the PHPdoc to @param Drupal\Core\StringTranslation $errorDecide on how to change the non-TranslatableMarkup calls. Most of them appear to be in tests or missing translations (ResponsiveImageStyle).
None.
If it is just a phpdoc, none. If we type the return value, it may qualify as an API change, but one that matches core implementations, and those implementations I looked at in contrib.
None.
None.
Needs work
10.1 ✨
Last updated
The doccomment change is OK, but as explained in the IS, there are 23 places in core where this change needs to be applied to, for default strings and test values. The PR needs to change all of that too.