TranslatorInterface.php

Same filename in this branch
  1. 11.x core/lib/Drupal/Core/StringTranslation/Translator/TranslatorInterface.php
Same filename in other branches
  1. 9 core/lib/Drupal/Core/StringTranslation/Translator/TranslatorInterface.php
  2. 9 core/lib/Drupal/Core/Validation/TranslatorInterface.php
  3. 8.9.x core/lib/Drupal/Core/StringTranslation/Translator/TranslatorInterface.php
  4. 8.9.x core/lib/Drupal/Core/Validation/TranslatorInterface.php
  5. 10 core/lib/Drupal/Core/StringTranslation/Translator/TranslatorInterface.php
  6. 10 core/lib/Drupal/Core/Validation/TranslatorInterface.php

Namespace

Drupal\Core\Validation

File

core/lib/Drupal/Core/Validation/TranslatorInterface.php

View source
<?php

namespace Drupal\Core\Validation;


/**
 * Defines an interface used in validation.
 *
 * This replaces the interface used by the Symfony validator in order
 * to indicate that the Drupal code is actually independent from the
 * Symfony translation component.
 *
 * @see https://github.com/symfony/symfony/pull/6189
 * @see https://github.com/symfony/symfony/issues/15714
 */
interface TranslatorInterface {
    
    /**
     * Translates the given message.
     *
     * @param string $id
     *   The message id (may also be an object that can be cast to string).
     * @param array $parameters
     *   An array of parameters for the message.
     * @param string|null $domain
     *   The domain for the message or null to use the default.
     * @param string|null $locale
     *   The locale or null to use the default.
     *
     * @return string
     *   The translated string.
     *
     * @throws \InvalidArgumentException
     *   If the locale contains invalid characters.
     */
    public function trans($id, array $parameters = [], $domain = NULL, $locale = NULL);

}

Interfaces

Title Deprecated Summary
TranslatorInterface Defines an interface used in validation.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.