12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394 |
- <?php
- namespace Drupal\Core\Annotation;
- use Drupal\Component\Annotation\AnnotationBase;
- use Drupal\Core\StringTranslation\TranslatableMarkup;
- /**
- * @defgroup plugin_translatable Annotation for translatable text
- * @{
- * Describes how to put translatable UI text into annotations.
- *
- * When providing plugin annotation, properties whose values are displayed in
- * the user interface should be made translatable. Much the same as how user
- * interface text elsewhere is wrapped in t() to make it translatable, in plugin
- * annotation, wrap translatable strings in the @ Translation() annotation.
- * For example:
- * @code
- * title = @ Translation("Title of the plugin"),
- * @endcode
- * Remove spaces after @ in your actual plugin - these are put into this sample
- * code so that it is not recognized as annotation.
- *
- * To provide replacement values for placeholders, use the "arguments" array:
- * @code
- * title = @ Translation("Bundle !title", arguments = {"!title" = "Foo"}),
- * @endcode
- *
- * It is also possible to provide a context with the text, similar to t():
- * @code
- * title = @ Translation("Bundle", context = "Validation"),
- * @endcode
- * Other t() arguments like language code are not valid to pass in. Only
- * context is supported.
- *
- * @see i18n
- * @see annotation
- * @}
- */
- /**
- * Defines a translatable annotation object.
- *
- * Some metadata within an annotation needs to be translatable. This class
- * supports that need by allowing both the translatable string and, if
- * specified, a context for that string. The string (with optional context)
- * is passed into t().
- *
- * @ingroup plugin_translatable
- *
- * @Annotation
- */
- class Translation extends AnnotationBase {
- /**
- * The string translation object.
- *
- * @var \Drupal\Core\StringTranslation\TranslatableMarkup
- */
- protected $translation;
- /**
- * Constructs a new class instance.
- *
- * Parses values passed into this class through the t() function in Drupal and
- * handles an optional context for the string.
- *
- * @param array $values
- * Possible array keys:
- * - value (required): the string that is to be translated.
- * - arguments (optional): an array with placeholder replacements, keyed by
- * placeholder.
- * - context (optional): a string that describes the context of "value";
- */
- public function __construct(array $values) {
- $string = $values['value'];
- $arguments = isset($values['arguments']) ? $values['arguments'] : [];
- $options = [];
- if (!empty($values['context'])) {
- $options = [
- 'context' => $values['context'],
- ];
- }
- $this->translation = new TranslatableMarkup($string, $arguments, $options);
- }
- /**
- * {@inheritdoc}
- */
- public function get() {
- return $this->translation;
- }
- }
|